Struct CollectionsApiClient

pub struct CollectionsApiClient { /* private fields */ }

Implementations

impl CollectionsApiClient

pub fn new(configuration: Arc<Configuration>) -> Self

Trait Implementations

impl CollectionsApi for CollectionsApiClient

fn create_collection<'life0, 'async_trait>( &'life0 self, params: CreateCollectionParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionResponse, Error<CreateCollectionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.

fn delete_collection<'life0, 'async_trait>( &'life0 self, params: DeleteCollectionParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionResponse, Error<DeleteCollectionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.

fn get_alias<'life0, 'async_trait>( &'life0 self, params: GetAliasParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionAlias, Error<GetAliasError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Find out which collection an alias points to by fetching it

fn get_aliases<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CollectionAliasesResponse, Error<GetAliasesError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all aliases and the corresponding collections that they map to.

fn get_collection<'life0, 'async_trait>( &'life0 self, params: GetCollectionParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionResponse, Error<GetCollectionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieve the details of a collection, given its name.

fn get_collections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<CollectionResponse>, Error<GetCollectionsError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

fn update_collection<'life0, 'async_trait>( &'life0 self, params: UpdateCollectionParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionUpdateSchema, Error<UpdateCollectionError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update a collection’s schema to modify the fields and their types.

fn upsert_alias<'life0, 'async_trait>( &'life0 self, params: UpsertAliasParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionAlias, Error<UpsertAliasError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you’re familiar with symbolic links on Linux, it’s very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.

fn delete_alias<'life0, 'async_trait>( &'life0 self, params: DeleteAliasParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionAlias, Error<DeleteAliasError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,