Documentation
¶
Index ¶
- type CreateCollectionOption
- type CreateCollectionOptions
- type CreateDocumentOption
- type CreateDocumentOptions
- type CreateDocumentsOption
- type CreateDocumentsOptions
- type CreateFailoverOption
- type CreateFailoverOptions
- type CreateIndexOption
- type CreateIndexOptions
- type CreateOperationsOption
- type CreateOperationsOptions
- type CreateOption
- type CreateOptions
- type CreateQueryOption
- type CreateQueryOptions
- type CreateTransactionOption
- type CreateTransactionOptions
- type DeleteDocumentOption
- type DeleteDocumentOptions
- type DeleteDocumentsOption
- type DeleteDocumentsOptions
- type GetDocumentOption
- type GetDocumentOptions
- type ListCollectionsOption
- type ListCollectionsOptions
- type ListDocumentsOption
- type ListDocumentsOptions
- type ListIndexesOption
- type ListIndexesOptions
- type ListOperationsOption
- type ListOperationsOptions
- type ListOption
- type ListOptions
- type ListTransactionsOption
- type ListTransactionsOptions
- type UpdateCollectionOption
- type UpdateCollectionOptions
- type UpdateDocumentOption
- type UpdateDocumentOptions
- type UpdateDocumentsOption
- type UpdateDocumentsOptions
- type UpdateOption
- type UpdateOptions
- type UpdateTransactionOption
- type UpdateTransactionOptions
- type UpsertDocumentOption
- type UpsertDocumentOptions
- type UpsertDocumentsOption
- type UpsertDocumentsOptions
- type VectorsDB
- func (srv *VectorsDB) Create(DatabaseId string, Name string, optionalSetters ...CreateOption) (*models.Database, error)
- func (srv *VectorsDB) CreateCollection(DatabaseId string, CollectionId string, Name string, Dimension int, ...) (*models.VectorsdbCollection, error)
- func (srv *VectorsDB) CreateDocument(DatabaseId string, CollectionId string, DocumentId string, Data interface{}, ...) (*models.Document, error)
- func (srv *VectorsDB) CreateDocuments(DatabaseId string, CollectionId string, Documents []interface{}, ...) (*models.DocumentList, error)
- func (srv *VectorsDB) CreateFailover(DatabaseId string, optionalSetters ...CreateFailoverOption) (*models.DedicatedDatabase, error)
- func (srv *VectorsDB) CreateIndex(DatabaseId string, CollectionId string, Key string, Type string, ...) (*models.Index, error)
- func (srv *VectorsDB) CreateOperations(TransactionId string, optionalSetters ...CreateOperationsOption) (*models.Transaction, error)
- func (srv *VectorsDB) CreateQuery(DatabaseId string, CollectionId string, optionalSetters ...CreateQueryOption) (*models.DocumentList, error)
- func (srv *VectorsDB) CreateTransaction(optionalSetters ...CreateTransactionOption) (*models.Transaction, error)
- func (srv *VectorsDB) Delete(DatabaseId string) (*interface{}, error)
- func (srv *VectorsDB) DeleteCollection(DatabaseId string, CollectionId string) (*interface{}, error)
- func (srv *VectorsDB) DeleteDocument(DatabaseId string, CollectionId string, DocumentId string, ...) (*interface{}, error)
- func (srv *VectorsDB) DeleteDocuments(DatabaseId string, CollectionId string, ...) (*models.DocumentList, error)
- func (srv *VectorsDB) DeleteIndex(DatabaseId string, CollectionId string, Key string) (*interface{}, error)
- func (srv *VectorsDB) DeleteTransaction(TransactionId string) (*interface{}, error)
- func (srv *VectorsDB) Get(DatabaseId string) (*models.Database, error)
- func (srv *VectorsDB) GetCollection(DatabaseId string, CollectionId string) (*models.VectorsdbCollection, error)
- func (srv *VectorsDB) GetDocument(DatabaseId string, CollectionId string, DocumentId string, ...) (*models.Document, error)
- func (srv *VectorsDB) GetIndex(DatabaseId string, CollectionId string, Key string) (*models.Index, error)
- func (srv *VectorsDB) GetReplicas(DatabaseId string) (*models.DedicatedDatabaseReplicas, error)
- func (srv *VectorsDB) GetStatus(DatabaseId string) (*models.DatabaseStatus, error)
- func (srv *VectorsDB) GetTransaction(TransactionId string) (*models.Transaction, error)
- func (srv *VectorsDB) List(optionalSetters ...ListOption) (*models.DatabaseList, error)
- func (srv *VectorsDB) ListCollections(DatabaseId string, optionalSetters ...ListCollectionsOption) (*models.VectorsdbCollectionList, error)
- func (srv *VectorsDB) ListDocuments(DatabaseId string, CollectionId string, optionalSetters ...ListDocumentsOption) (*models.DocumentList, error)
- func (srv *VectorsDB) ListIndexes(DatabaseId string, CollectionId string, optionalSetters ...ListIndexesOption) (*models.IndexList, error)
- func (srv *VectorsDB) ListOperations(DatabaseId string, optionalSetters ...ListOperationsOption) (*models.DedicatedDatabaseOperationList, error)
- func (srv *VectorsDB) ListSpecifications() (*models.DedicatedDatabaseSpecificationList, error)
- func (srv *VectorsDB) ListTransactions(optionalSetters ...ListTransactionsOption) (*models.TransactionList, error)
- func (srv *VectorsDB) Update(DatabaseId string, Name string, optionalSetters ...UpdateOption) (*models.Database, error)
- func (srv *VectorsDB) UpdateCollection(DatabaseId string, CollectionId string, Name string, ...) (*models.VectorsdbCollection, error)
- func (srv *VectorsDB) UpdateDocument(DatabaseId string, CollectionId string, DocumentId string, ...) (*models.Document, error)
- func (srv *VectorsDB) UpdateDocuments(DatabaseId string, CollectionId string, ...) (*models.DocumentList, error)
- func (srv *VectorsDB) UpdateTransaction(TransactionId string, optionalSetters ...UpdateTransactionOption) (*models.Transaction, error)
- func (srv *VectorsDB) UpsertDocument(DatabaseId string, CollectionId string, DocumentId string, ...) (*models.Document, error)
- func (srv *VectorsDB) UpsertDocuments(DatabaseId string, CollectionId string, Documents []interface{}, ...) (*models.DocumentList, error)
- func (srv *VectorsDB) WithCreateCollectionDocumentSecurity(v bool) CreateCollectionOption
- func (srv *VectorsDB) WithCreateCollectionEnabled(v bool) CreateCollectionOption
- func (srv *VectorsDB) WithCreateCollectionPermissions(v []string) CreateCollectionOption
- func (srv *VectorsDB) WithCreateDocumentPermissions(v []string) CreateDocumentOption
- func (srv *VectorsDB) WithCreateDocumentTransactionId(v string) CreateDocumentOption
- func (srv *VectorsDB) WithCreateDocumentsTransactionId(v string) CreateDocumentsOption
- func (srv *VectorsDB) WithCreateEnabled(v bool) CreateOption
- func (srv *VectorsDB) WithCreateFailoverTargetReplicaId(v string) CreateFailoverOption
- func (srv *VectorsDB) WithCreateIndexLengths(v []int) CreateIndexOption
- func (srv *VectorsDB) WithCreateIndexOrders(v []string) CreateIndexOption
- func (srv *VectorsDB) WithCreateOperationsOperations(v []interface{}) CreateOperationsOption
- func (srv *VectorsDB) WithCreateQueryQueries(v []string) CreateQueryOption
- func (srv *VectorsDB) WithCreateQueryTotal(v bool) CreateQueryOption
- func (srv *VectorsDB) WithCreateQueryTransactionId(v string) CreateQueryOption
- func (srv *VectorsDB) WithCreateQueryTtl(v int) CreateQueryOption
- func (srv *VectorsDB) WithCreateReplicas(v int) CreateOption
- func (srv *VectorsDB) WithCreateSpecification(v string) CreateOption
- func (srv *VectorsDB) WithCreateSyncMode(v string) CreateOption
- func (srv *VectorsDB) WithCreateTransactionTtl(v int) CreateTransactionOption
- func (srv *VectorsDB) WithDeleteDocumentTransactionId(v string) DeleteDocumentOption
- func (srv *VectorsDB) WithDeleteDocumentsQueries(v []string) DeleteDocumentsOption
- func (srv *VectorsDB) WithDeleteDocumentsTransactionId(v string) DeleteDocumentsOption
- func (srv *VectorsDB) WithGetDocumentQueries(v []string) GetDocumentOption
- func (srv *VectorsDB) WithGetDocumentTransactionId(v string) GetDocumentOption
- func (srv *VectorsDB) WithListCollectionsQueries(v []string) ListCollectionsOption
- func (srv *VectorsDB) WithListCollectionsSearch(v string) ListCollectionsOption
- func (srv *VectorsDB) WithListCollectionsTotal(v bool) ListCollectionsOption
- func (srv *VectorsDB) WithListDocumentsQueries(v []string) ListDocumentsOption
- func (srv *VectorsDB) WithListDocumentsTotal(v bool) ListDocumentsOption
- func (srv *VectorsDB) WithListDocumentsTransactionId(v string) ListDocumentsOption
- func (srv *VectorsDB) WithListDocumentsTtl(v int) ListDocumentsOption
- func (srv *VectorsDB) WithListIndexesQueries(v []string) ListIndexesOption
- func (srv *VectorsDB) WithListIndexesTotal(v bool) ListIndexesOption
- func (srv *VectorsDB) WithListOperationsLimit(v int) ListOperationsOption
- func (srv *VectorsDB) WithListOperationsOffset(v int) ListOperationsOption
- func (srv *VectorsDB) WithListOperationsStatus(v string) ListOperationsOption
- func (srv *VectorsDB) WithListQueries(v []string) ListOption
- func (srv *VectorsDB) WithListTotal(v bool) ListOption
- func (srv *VectorsDB) WithListTransactionsQueries(v []string) ListTransactionsOption
- func (srv *VectorsDB) WithUpdateCollectionDimension(v int) UpdateCollectionOption
- func (srv *VectorsDB) WithUpdateCollectionDocumentSecurity(v bool) UpdateCollectionOption
- func (srv *VectorsDB) WithUpdateCollectionEnabled(v bool) UpdateCollectionOption
- func (srv *VectorsDB) WithUpdateCollectionPermissions(v []string) UpdateCollectionOption
- func (srv *VectorsDB) WithUpdateDocumentData(v interface{}) UpdateDocumentOption
- func (srv *VectorsDB) WithUpdateDocumentPermissions(v []string) UpdateDocumentOption
- func (srv *VectorsDB) WithUpdateDocumentTransactionId(v string) UpdateDocumentOption
- func (srv *VectorsDB) WithUpdateDocumentsData(v interface{}) UpdateDocumentsOption
- func (srv *VectorsDB) WithUpdateDocumentsQueries(v []string) UpdateDocumentsOption
- func (srv *VectorsDB) WithUpdateDocumentsTransactionId(v string) UpdateDocumentsOption
- func (srv *VectorsDB) WithUpdateEnabled(v bool) UpdateOption
- func (srv *VectorsDB) WithUpdateReplicas(v int) UpdateOption
- func (srv *VectorsDB) WithUpdateSpecification(v string) UpdateOption
- func (srv *VectorsDB) WithUpdateSyncMode(v string) UpdateOption
- func (srv *VectorsDB) WithUpdateTransactionCommit(v bool) UpdateTransactionOption
- func (srv *VectorsDB) WithUpdateTransactionRollback(v bool) UpdateTransactionOption
- func (srv *VectorsDB) WithUpsertDocumentData(v interface{}) UpsertDocumentOption
- func (srv *VectorsDB) WithUpsertDocumentPermissions(v []string) UpsertDocumentOption
- func (srv *VectorsDB) WithUpsertDocumentTransactionId(v string) UpsertDocumentOption
- func (srv *VectorsDB) WithUpsertDocumentsTransactionId(v string) UpsertDocumentsOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateCollectionOption ¶
type CreateCollectionOption func(*CreateCollectionOptions)
type CreateCollectionOptions ¶
type CreateCollectionOptions struct {
Permissions []string
DocumentSecurity bool
Enabled bool
// contains filtered or unexported fields
}
func (CreateCollectionOptions) New ¶
func (options CreateCollectionOptions) New() *CreateCollectionOptions
type CreateDocumentOption ¶
type CreateDocumentOption func(*CreateDocumentOptions)
type CreateDocumentOptions ¶
type CreateDocumentOptions struct {
Permissions []string
TransactionId string
// contains filtered or unexported fields
}
func (CreateDocumentOptions) New ¶
func (options CreateDocumentOptions) New() *CreateDocumentOptions
type CreateDocumentsOption ¶
type CreateDocumentsOption func(*CreateDocumentsOptions)
type CreateDocumentsOptions ¶
type CreateDocumentsOptions struct {
TransactionId string
// contains filtered or unexported fields
}
func (CreateDocumentsOptions) New ¶
func (options CreateDocumentsOptions) New() *CreateDocumentsOptions
type CreateFailoverOption ¶
type CreateFailoverOption func(*CreateFailoverOptions)
type CreateFailoverOptions ¶
type CreateFailoverOptions struct {
TargetReplicaId string
// contains filtered or unexported fields
}
func (CreateFailoverOptions) New ¶
func (options CreateFailoverOptions) New() *CreateFailoverOptions
type CreateIndexOption ¶
type CreateIndexOption func(*CreateIndexOptions)
type CreateIndexOptions ¶
type CreateIndexOptions struct {
Orders []string
Lengths []int
// contains filtered or unexported fields
}
func (CreateIndexOptions) New ¶
func (options CreateIndexOptions) New() *CreateIndexOptions
type CreateOperationsOption ¶
type CreateOperationsOption func(*CreateOperationsOptions)
type CreateOperationsOptions ¶
type CreateOperationsOptions struct {
Operations []interface{}
// contains filtered or unexported fields
}
func (CreateOperationsOptions) New ¶
func (options CreateOperationsOptions) New() *CreateOperationsOptions
type CreateOption ¶
type CreateOption func(*CreateOptions)
type CreateOptions ¶
type CreateOptions struct {
Enabled bool
Specification string
Replicas int
SyncMode string
// contains filtered or unexported fields
}
func (CreateOptions) New ¶
func (options CreateOptions) New() *CreateOptions
type CreateQueryOption ¶
type CreateQueryOption func(*CreateQueryOptions)
type CreateQueryOptions ¶
type CreateQueryOptions struct {
Queries []string
TransactionId string
Total bool
Ttl int
// contains filtered or unexported fields
}
func (CreateQueryOptions) New ¶
func (options CreateQueryOptions) New() *CreateQueryOptions
type CreateTransactionOption ¶
type CreateTransactionOption func(*CreateTransactionOptions)
type CreateTransactionOptions ¶
type CreateTransactionOptions struct {
Ttl int
// contains filtered or unexported fields
}
func (CreateTransactionOptions) New ¶
func (options CreateTransactionOptions) New() *CreateTransactionOptions
type DeleteDocumentOption ¶
type DeleteDocumentOption func(*DeleteDocumentOptions)
type DeleteDocumentOptions ¶
type DeleteDocumentOptions struct {
TransactionId string
// contains filtered or unexported fields
}
func (DeleteDocumentOptions) New ¶
func (options DeleteDocumentOptions) New() *DeleteDocumentOptions
type DeleteDocumentsOption ¶
type DeleteDocumentsOption func(*DeleteDocumentsOptions)
type DeleteDocumentsOptions ¶
type DeleteDocumentsOptions struct {
Queries []string
TransactionId string
// contains filtered or unexported fields
}
func (DeleteDocumentsOptions) New ¶
func (options DeleteDocumentsOptions) New() *DeleteDocumentsOptions
type GetDocumentOption ¶
type GetDocumentOption func(*GetDocumentOptions)
type GetDocumentOptions ¶
type GetDocumentOptions struct {
Queries []string
TransactionId string
// contains filtered or unexported fields
}
func (GetDocumentOptions) New ¶
func (options GetDocumentOptions) New() *GetDocumentOptions
type ListCollectionsOption ¶
type ListCollectionsOption func(*ListCollectionsOptions)
type ListCollectionsOptions ¶
type ListCollectionsOptions struct {
Queries []string
Search string
Total bool
// contains filtered or unexported fields
}
func (ListCollectionsOptions) New ¶
func (options ListCollectionsOptions) New() *ListCollectionsOptions
type ListDocumentsOption ¶
type ListDocumentsOption func(*ListDocumentsOptions)
type ListDocumentsOptions ¶
type ListDocumentsOptions struct {
Queries []string
TransactionId string
Total bool
Ttl int
// contains filtered or unexported fields
}
func (ListDocumentsOptions) New ¶
func (options ListDocumentsOptions) New() *ListDocumentsOptions
type ListIndexesOption ¶
type ListIndexesOption func(*ListIndexesOptions)
type ListIndexesOptions ¶
type ListIndexesOptions struct {
Queries []string
Total bool
// contains filtered or unexported fields
}
func (ListIndexesOptions) New ¶
func (options ListIndexesOptions) New() *ListIndexesOptions
type ListOperationsOption ¶
type ListOperationsOption func(*ListOperationsOptions)
type ListOperationsOptions ¶
type ListOperationsOptions struct {
Status string
Limit int
Offset int
// contains filtered or unexported fields
}
func (ListOperationsOptions) New ¶
func (options ListOperationsOptions) New() *ListOperationsOptions
type ListOption ¶
type ListOption func(*ListOptions)
type ListOptions ¶
func (ListOptions) New ¶
func (options ListOptions) New() *ListOptions
type ListTransactionsOption ¶
type ListTransactionsOption func(*ListTransactionsOptions)
type ListTransactionsOptions ¶
type ListTransactionsOptions struct {
Queries []string
// contains filtered or unexported fields
}
func (ListTransactionsOptions) New ¶
func (options ListTransactionsOptions) New() *ListTransactionsOptions
type UpdateCollectionOption ¶
type UpdateCollectionOption func(*UpdateCollectionOptions)
type UpdateCollectionOptions ¶
type UpdateCollectionOptions struct {
Dimension int
Permissions []string
DocumentSecurity bool
Enabled bool
// contains filtered or unexported fields
}
func (UpdateCollectionOptions) New ¶
func (options UpdateCollectionOptions) New() *UpdateCollectionOptions
type UpdateDocumentOption ¶
type UpdateDocumentOption func(*UpdateDocumentOptions)
type UpdateDocumentOptions ¶
type UpdateDocumentOptions struct {
Data interface{}
Permissions []string
TransactionId string
// contains filtered or unexported fields
}
func (UpdateDocumentOptions) New ¶
func (options UpdateDocumentOptions) New() *UpdateDocumentOptions
type UpdateDocumentsOption ¶
type UpdateDocumentsOption func(*UpdateDocumentsOptions)
type UpdateDocumentsOptions ¶
type UpdateDocumentsOptions struct {
Data interface{}
Queries []string
TransactionId string
// contains filtered or unexported fields
}
func (UpdateDocumentsOptions) New ¶
func (options UpdateDocumentsOptions) New() *UpdateDocumentsOptions
type UpdateOption ¶
type UpdateOption func(*UpdateOptions)
type UpdateOptions ¶
type UpdateOptions struct {
Enabled bool
Specification string
Replicas int
SyncMode string
// contains filtered or unexported fields
}
func (UpdateOptions) New ¶
func (options UpdateOptions) New() *UpdateOptions
type UpdateTransactionOption ¶
type UpdateTransactionOption func(*UpdateTransactionOptions)
type UpdateTransactionOptions ¶
type UpdateTransactionOptions struct {
Commit bool
Rollback bool
// contains filtered or unexported fields
}
func (UpdateTransactionOptions) New ¶
func (options UpdateTransactionOptions) New() *UpdateTransactionOptions
type UpsertDocumentOption ¶
type UpsertDocumentOption func(*UpsertDocumentOptions)
type UpsertDocumentOptions ¶
type UpsertDocumentOptions struct {
Data interface{}
Permissions []string
TransactionId string
// contains filtered or unexported fields
}
func (UpsertDocumentOptions) New ¶
func (options UpsertDocumentOptions) New() *UpsertDocumentOptions
type UpsertDocumentsOption ¶
type UpsertDocumentsOption func(*UpsertDocumentsOptions)
type UpsertDocumentsOptions ¶
type UpsertDocumentsOptions struct {
TransactionId string
// contains filtered or unexported fields
}
func (UpsertDocumentsOptions) New ¶
func (options UpsertDocumentsOptions) New() *UpsertDocumentsOptions
type VectorsDB ¶
type VectorsDB struct {
// contains filtered or unexported fields
}
VectorsDB service
func (*VectorsDB) Create ¶
func (srv *VectorsDB) Create(DatabaseId string, Name string, optionalSetters ...CreateOption) (*models.Database, error)
Create create a new Database.
func (*VectorsDB) CreateCollection ¶
func (srv *VectorsDB) CreateCollection(DatabaseId string, CollectionId string, Name string, Dimension int, optionalSetters ...CreateCollectionOption) (*models.VectorsdbCollection, error)
CreateCollection create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
func (*VectorsDB) CreateDocument ¶
func (srv *VectorsDB) CreateDocument(DatabaseId string, CollectionId string, DocumentId string, Data interface{}, optionalSetters ...CreateDocumentOption) (*models.Document, error)
CreateDocument create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
func (*VectorsDB) CreateDocuments ¶
func (srv *VectorsDB) CreateDocuments(DatabaseId string, CollectionId string, Documents []interface{}, optionalSetters ...CreateDocumentsOption) (*models.DocumentList, error)
CreateDocuments create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
func (*VectorsDB) CreateFailover ¶
func (srv *VectorsDB) CreateFailover(DatabaseId string, optionalSetters ...CreateFailoverOption) (*models.DedicatedDatabase, error)
CreateFailover trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation also accepts this call as a repair once nothing is driving the operation it is stuck in. Repairing a failover that did not finish, a `failed` database, a stranded upgrade or migrate, or a stranded compute resize additionally requires `targetReplicaId` to name the member to promote, because the default target may be the member that operation already promoted.
func (*VectorsDB) CreateIndex ¶
func (srv *VectorsDB) CreateIndex(DatabaseId string, CollectionId string, Key string, Type string, Attributes []string, optionalSetters ...CreateIndexOption) (*models.Index, error)
CreateIndex creates an index on the attributes listed. Your index should include all the attributes you will query in a single request. Attributes can be `key`, `fulltext`, and `unique`.
func (*VectorsDB) CreateOperations ¶
func (srv *VectorsDB) CreateOperations(TransactionId string, optionalSetters ...CreateOperationsOption) (*models.Transaction, error)
CreateOperations create multiple operations in a single transaction.
func (*VectorsDB) CreateQuery ¶
func (srv *VectorsDB) CreateQuery(DatabaseId string, CollectionId string, optionalSetters ...CreateQueryOption) (*models.DocumentList, error)
CreateQuery get a list of all the user's documents in a given collection using a POST request. This behaves identically to the list documents endpoint but accepts the queries in the request body, allowing much larger `queries` arrays than can fit in a URL query string.
func (*VectorsDB) CreateTransaction ¶
func (srv *VectorsDB) CreateTransaction(optionalSetters ...CreateTransactionOption) (*models.Transaction, error)
CreateTransaction create a new transaction.
func (*VectorsDB) Delete ¶
Delete delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
func (*VectorsDB) DeleteCollection ¶
func (srv *VectorsDB) DeleteCollection(DatabaseId string, CollectionId string) (*interface{}, error)
DeleteCollection delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
func (*VectorsDB) DeleteDocument ¶
func (srv *VectorsDB) DeleteDocument(DatabaseId string, CollectionId string, DocumentId string, optionalSetters ...DeleteDocumentOption) (*interface{}, error)
DeleteDocument delete a document by its unique ID.
func (*VectorsDB) DeleteDocuments ¶
func (srv *VectorsDB) DeleteDocuments(DatabaseId string, CollectionId string, optionalSetters ...DeleteDocumentsOption) (*models.DocumentList, error)
DeleteDocuments bulk delete documents using queries, if no queries are passed then all documents are deleted.
func (*VectorsDB) DeleteIndex ¶
func (srv *VectorsDB) DeleteIndex(DatabaseId string, CollectionId string, Key string) (*interface{}, error)
DeleteIndex delete an index.
func (*VectorsDB) DeleteTransaction ¶
DeleteTransaction delete a transaction by its unique ID.
func (*VectorsDB) Get ¶
Get get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
func (*VectorsDB) GetCollection ¶
func (srv *VectorsDB) GetCollection(DatabaseId string, CollectionId string) (*models.VectorsdbCollection, error)
GetCollection get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
func (*VectorsDB) GetDocument ¶
func (srv *VectorsDB) GetDocument(DatabaseId string, CollectionId string, DocumentId string, optionalSetters ...GetDocumentOption) (*models.Document, error)
GetDocument get a document by its unique ID. This endpoint response returns a JSON object with the document data.
func (*VectorsDB) GetIndex ¶
func (srv *VectorsDB) GetIndex(DatabaseId string, CollectionId string, Key string) (*models.Index, error)
GetIndex get index by ID.
func (*VectorsDB) GetReplicas ¶
func (srv *VectorsDB) GetReplicas(DatabaseId string) (*models.DedicatedDatabaseReplicas, error)
GetReplicas get high availability status for a dedicated database. Returns replica statuses, replication lag, and sync mode.
func (*VectorsDB) GetStatus ¶
func (srv *VectorsDB) GetStatus(DatabaseId string) (*models.DatabaseStatus, error)
GetStatus get real-time health and status information for a dedicated database. Returns health status, readiness, uptime, connection info, replica status, and volume information.
func (*VectorsDB) GetTransaction ¶
func (srv *VectorsDB) GetTransaction(TransactionId string) (*models.Transaction, error)
GetTransaction get a transaction by its unique ID.
func (*VectorsDB) List ¶
func (srv *VectorsDB) List(optionalSetters ...ListOption) (*models.DatabaseList, error)
List get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.
func (*VectorsDB) ListCollections ¶
func (srv *VectorsDB) ListCollections(DatabaseId string, optionalSetters ...ListCollectionsOption) (*models.VectorsdbCollectionList, error)
ListCollections get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
func (*VectorsDB) ListDocuments ¶
func (srv *VectorsDB) ListDocuments(DatabaseId string, CollectionId string, optionalSetters ...ListDocumentsOption) (*models.DocumentList, error)
ListDocuments get a list of all the user's documents in a given collection. You can use the query params to filter your results.
func (*VectorsDB) ListIndexes ¶
func (srv *VectorsDB) ListIndexes(DatabaseId string, CollectionId string, optionalSetters ...ListIndexesOption) (*models.IndexList, error)
ListIndexes list indexes in the collection.
func (*VectorsDB) ListOperations ¶
func (srv *VectorsDB) ListOperations(DatabaseId string, optionalSetters ...ListOperationsOption) (*models.DedicatedDatabaseOperationList, error)
ListOperations list the lifecycle operations recorded for a dedicated database, newest first. Every provision, update, restore, backup and replication action is recorded here with its outcome, including an attempt that was abandoned because another worker took over the database.
func (*VectorsDB) ListSpecifications ¶
func (srv *VectorsDB) ListSpecifications() (*models.DedicatedDatabaseSpecificationList, error)
ListSpecifications list the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.
func (*VectorsDB) ListTransactions ¶
func (srv *VectorsDB) ListTransactions(optionalSetters ...ListTransactionsOption) (*models.TransactionList, error)
ListTransactions list transactions across all databases.
func (*VectorsDB) Update ¶
func (srv *VectorsDB) Update(DatabaseId string, Name string, optionalSetters ...UpdateOption) (*models.Database, error)
Update update a database by its unique ID.
func (*VectorsDB) UpdateCollection ¶
func (srv *VectorsDB) UpdateCollection(DatabaseId string, CollectionId string, Name string, optionalSetters ...UpdateCollectionOption) (*models.VectorsdbCollection, error)
UpdateCollection update a collection by its unique ID.
func (*VectorsDB) UpdateDocument ¶
func (srv *VectorsDB) UpdateDocument(DatabaseId string, CollectionId string, DocumentId string, optionalSetters ...UpdateDocumentOption) (*models.Document, error)
UpdateDocument update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
func (*VectorsDB) UpdateDocuments ¶
func (srv *VectorsDB) UpdateDocuments(DatabaseId string, CollectionId string, optionalSetters ...UpdateDocumentsOption) (*models.DocumentList, error)
UpdateDocuments update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
func (*VectorsDB) UpdateTransaction ¶
func (srv *VectorsDB) UpdateTransaction(TransactionId string, optionalSetters ...UpdateTransactionOption) (*models.Transaction, error)
UpdateTransaction update a transaction, to either commit or roll back its operations.
func (*VectorsDB) UpsertDocument ¶
func (srv *VectorsDB) UpsertDocument(DatabaseId string, CollectionId string, DocumentId string, optionalSetters ...UpsertDocumentOption) (*models.Document, error)
UpsertDocument create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
func (*VectorsDB) UpsertDocuments ¶
func (srv *VectorsDB) UpsertDocuments(DatabaseId string, CollectionId string, Documents []interface{}, optionalSetters ...UpsertDocumentsOption) (*models.DocumentList, error)
UpsertDocuments create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
func (*VectorsDB) WithCreateCollectionDocumentSecurity ¶
func (srv *VectorsDB) WithCreateCollectionDocumentSecurity(v bool) CreateCollectionOption
func (*VectorsDB) WithCreateCollectionEnabled ¶
func (srv *VectorsDB) WithCreateCollectionEnabled(v bool) CreateCollectionOption
func (*VectorsDB) WithCreateCollectionPermissions ¶
func (srv *VectorsDB) WithCreateCollectionPermissions(v []string) CreateCollectionOption
func (*VectorsDB) WithCreateDocumentPermissions ¶
func (srv *VectorsDB) WithCreateDocumentPermissions(v []string) CreateDocumentOption
func (*VectorsDB) WithCreateDocumentTransactionId ¶
func (srv *VectorsDB) WithCreateDocumentTransactionId(v string) CreateDocumentOption
func (*VectorsDB) WithCreateDocumentsTransactionId ¶
func (srv *VectorsDB) WithCreateDocumentsTransactionId(v string) CreateDocumentsOption
func (*VectorsDB) WithCreateEnabled ¶
func (srv *VectorsDB) WithCreateEnabled(v bool) CreateOption
func (*VectorsDB) WithCreateFailoverTargetReplicaId ¶
func (srv *VectorsDB) WithCreateFailoverTargetReplicaId(v string) CreateFailoverOption
func (*VectorsDB) WithCreateIndexLengths ¶
func (srv *VectorsDB) WithCreateIndexLengths(v []int) CreateIndexOption
func (*VectorsDB) WithCreateIndexOrders ¶
func (srv *VectorsDB) WithCreateIndexOrders(v []string) CreateIndexOption
func (*VectorsDB) WithCreateOperationsOperations ¶
func (srv *VectorsDB) WithCreateOperationsOperations(v []interface{}) CreateOperationsOption
func (*VectorsDB) WithCreateQueryQueries ¶
func (srv *VectorsDB) WithCreateQueryQueries(v []string) CreateQueryOption
func (*VectorsDB) WithCreateQueryTotal ¶
func (srv *VectorsDB) WithCreateQueryTotal(v bool) CreateQueryOption
func (*VectorsDB) WithCreateQueryTransactionId ¶
func (srv *VectorsDB) WithCreateQueryTransactionId(v string) CreateQueryOption
func (*VectorsDB) WithCreateQueryTtl ¶
func (srv *VectorsDB) WithCreateQueryTtl(v int) CreateQueryOption
func (*VectorsDB) WithCreateReplicas ¶
func (srv *VectorsDB) WithCreateReplicas(v int) CreateOption
func (*VectorsDB) WithCreateSpecification ¶
func (srv *VectorsDB) WithCreateSpecification(v string) CreateOption
func (*VectorsDB) WithCreateSyncMode ¶
func (srv *VectorsDB) WithCreateSyncMode(v string) CreateOption
func (*VectorsDB) WithCreateTransactionTtl ¶
func (srv *VectorsDB) WithCreateTransactionTtl(v int) CreateTransactionOption
func (*VectorsDB) WithDeleteDocumentTransactionId ¶
func (srv *VectorsDB) WithDeleteDocumentTransactionId(v string) DeleteDocumentOption
func (*VectorsDB) WithDeleteDocumentsQueries ¶
func (srv *VectorsDB) WithDeleteDocumentsQueries(v []string) DeleteDocumentsOption
func (*VectorsDB) WithDeleteDocumentsTransactionId ¶
func (srv *VectorsDB) WithDeleteDocumentsTransactionId(v string) DeleteDocumentsOption
func (*VectorsDB) WithGetDocumentQueries ¶
func (srv *VectorsDB) WithGetDocumentQueries(v []string) GetDocumentOption
func (*VectorsDB) WithGetDocumentTransactionId ¶
func (srv *VectorsDB) WithGetDocumentTransactionId(v string) GetDocumentOption
func (*VectorsDB) WithListCollectionsQueries ¶
func (srv *VectorsDB) WithListCollectionsQueries(v []string) ListCollectionsOption
func (*VectorsDB) WithListCollectionsSearch ¶
func (srv *VectorsDB) WithListCollectionsSearch(v string) ListCollectionsOption
func (*VectorsDB) WithListCollectionsTotal ¶
func (srv *VectorsDB) WithListCollectionsTotal(v bool) ListCollectionsOption
func (*VectorsDB) WithListDocumentsQueries ¶
func (srv *VectorsDB) WithListDocumentsQueries(v []string) ListDocumentsOption
func (*VectorsDB) WithListDocumentsTotal ¶
func (srv *VectorsDB) WithListDocumentsTotal(v bool) ListDocumentsOption
func (*VectorsDB) WithListDocumentsTransactionId ¶
func (srv *VectorsDB) WithListDocumentsTransactionId(v string) ListDocumentsOption
func (*VectorsDB) WithListDocumentsTtl ¶
func (srv *VectorsDB) WithListDocumentsTtl(v int) ListDocumentsOption
func (*VectorsDB) WithListIndexesQueries ¶
func (srv *VectorsDB) WithListIndexesQueries(v []string) ListIndexesOption
func (*VectorsDB) WithListIndexesTotal ¶
func (srv *VectorsDB) WithListIndexesTotal(v bool) ListIndexesOption
func (*VectorsDB) WithListOperationsLimit ¶
func (srv *VectorsDB) WithListOperationsLimit(v int) ListOperationsOption
func (*VectorsDB) WithListOperationsOffset ¶
func (srv *VectorsDB) WithListOperationsOffset(v int) ListOperationsOption
func (*VectorsDB) WithListOperationsStatus ¶
func (srv *VectorsDB) WithListOperationsStatus(v string) ListOperationsOption
func (*VectorsDB) WithListQueries ¶
func (srv *VectorsDB) WithListQueries(v []string) ListOption
func (*VectorsDB) WithListTotal ¶
func (srv *VectorsDB) WithListTotal(v bool) ListOption
func (*VectorsDB) WithListTransactionsQueries ¶
func (srv *VectorsDB) WithListTransactionsQueries(v []string) ListTransactionsOption
func (*VectorsDB) WithUpdateCollectionDimension ¶
func (srv *VectorsDB) WithUpdateCollectionDimension(v int) UpdateCollectionOption
func (*VectorsDB) WithUpdateCollectionDocumentSecurity ¶
func (srv *VectorsDB) WithUpdateCollectionDocumentSecurity(v bool) UpdateCollectionOption
func (*VectorsDB) WithUpdateCollectionEnabled ¶
func (srv *VectorsDB) WithUpdateCollectionEnabled(v bool) UpdateCollectionOption
func (*VectorsDB) WithUpdateCollectionPermissions ¶
func (srv *VectorsDB) WithUpdateCollectionPermissions(v []string) UpdateCollectionOption
func (*VectorsDB) WithUpdateDocumentData ¶
func (srv *VectorsDB) WithUpdateDocumentData(v interface{}) UpdateDocumentOption
func (*VectorsDB) WithUpdateDocumentPermissions ¶
func (srv *VectorsDB) WithUpdateDocumentPermissions(v []string) UpdateDocumentOption
func (*VectorsDB) WithUpdateDocumentTransactionId ¶
func (srv *VectorsDB) WithUpdateDocumentTransactionId(v string) UpdateDocumentOption
func (*VectorsDB) WithUpdateDocumentsData ¶
func (srv *VectorsDB) WithUpdateDocumentsData(v interface{}) UpdateDocumentsOption
func (*VectorsDB) WithUpdateDocumentsQueries ¶
func (srv *VectorsDB) WithUpdateDocumentsQueries(v []string) UpdateDocumentsOption
func (*VectorsDB) WithUpdateDocumentsTransactionId ¶
func (srv *VectorsDB) WithUpdateDocumentsTransactionId(v string) UpdateDocumentsOption
func (*VectorsDB) WithUpdateEnabled ¶
func (srv *VectorsDB) WithUpdateEnabled(v bool) UpdateOption
func (*VectorsDB) WithUpdateReplicas ¶
func (srv *VectorsDB) WithUpdateReplicas(v int) UpdateOption
func (*VectorsDB) WithUpdateSpecification ¶
func (srv *VectorsDB) WithUpdateSpecification(v string) UpdateOption
func (*VectorsDB) WithUpdateSyncMode ¶
func (srv *VectorsDB) WithUpdateSyncMode(v string) UpdateOption
func (*VectorsDB) WithUpdateTransactionCommit ¶
func (srv *VectorsDB) WithUpdateTransactionCommit(v bool) UpdateTransactionOption
func (*VectorsDB) WithUpdateTransactionRollback ¶
func (srv *VectorsDB) WithUpdateTransactionRollback(v bool) UpdateTransactionOption
func (*VectorsDB) WithUpsertDocumentData ¶
func (srv *VectorsDB) WithUpsertDocumentData(v interface{}) UpsertDocumentOption
func (*VectorsDB) WithUpsertDocumentPermissions ¶
func (srv *VectorsDB) WithUpsertDocumentPermissions(v []string) UpsertDocumentOption
func (*VectorsDB) WithUpsertDocumentTransactionId ¶
func (srv *VectorsDB) WithUpsertDocumentTransactionId(v string) UpsertDocumentOption
func (*VectorsDB) WithUpsertDocumentsTransactionId ¶
func (srv *VectorsDB) WithUpsertDocumentsTransactionId(v string) UpsertDocumentsOption