ExTypesense.Preset (ExTypesense v2.0.1)
View SourceSearch presets allow you to store a bunch of search parameters together, and reference them by a name. You can then use this preset name when you make a search request, instead of passing all the search parameters individually in each search request.
You can then change the preset configuration on the Typesense side, to change your search parameters, without having to re-deploy your application.
More here: https://typesense.org/docs/latest/api/search.html#presets
Summary
Functions
Permanently deletes a preset, given it's name.
Retrieves all presets.
Retrieves all presets.
Same as list_presets/0
Create or update an existing preset.
Functions
@spec delete_preset(String.t()) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Permanently deletes a preset, given it's name.
@spec delete_preset( String.t(), keyword() ) :: {:ok, OpenApiTypesense.PresetDeleteSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as delete_preset/1
Options
conn
: The custom connection map or struct you passed
Examples
iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.delete_preset("listing_view", conn: conn)
iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.delete_preset("listing_view", conn: conn)
iex> opts = [conn: conn]
iex> ExTypesense.delete_preset("listing_view", opts)
@spec get_preset(String.t()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Retrieves all presets.
@spec get_preset( String.t(), keyword() ) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as get_preset/1
Options
conn
: The custom connection map or struct you passed
Examples
iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.get_preset("listing_view", conn: conn)
iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.get_preset("listing_view", conn: conn)
iex> opts = [conn: conn]
iex> ExTypesense.get_preset("listing_view", opts)
@spec list_presets() :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | :error
Retrieves all presets.
@spec list_presets(map() | OpenApiTypesense.Connection.t() | keyword()) :: {:ok, OpenApiTypesense.PresetsRetrieveSchema.t()} | :error
Same as list_presets/0
Options
conn
: The custom connection map or struct you passed
Examples
iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.list_presets(conn: conn)
iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.list_presets(conn: conn)
iex> opts = [conn: conn]
iex> ExTypesense.list_presets(opts)
@spec upsert_preset(String.t(), map()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Create or update an existing preset.
Examples
iex> body = %{
...> "value" => %{
...> "searches" => [
...> %{"collection" => "restaurants", "q" => "*", "sort_by" => "popularity"}
...> ]
...> }
...> }
iex> ExTypesense.upsert_preset("listing_view", body)
@spec upsert_preset(String.t(), map(), keyword()) :: {:ok, OpenApiTypesense.PresetSchema.t()} | {:error, OpenApiTypesense.ApiResponse.t()}
Same as upsert_preset/2
Options
conn
: The custom connection map or struct you passed
Examples
iex> conn = %{api_key: xyz, host: ...}
iex> ExTypesense.upsert_preset("listing_view", body, conn: conn)
iex> conn = OpenApiTypesense.Connection.new()
iex> ExTypesense.upsert_preset("listing_view", body, conn: conn)
iex> opts = [conn: conn]
iex> ExTypesense.upsert_preset("listing_view", body, opts)