databases

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 18, 2025 License: BSD-3-Clause Imports: 5 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateBooleanAttributeOption 

type CreateBooleanAttributeOption func(*CreateBooleanAttributeOptions)

type CreateBooleanAttributeOptions 

type CreateBooleanAttributeOptions struct {
	Default bool
	Array   bool
	// contains filtered or unexported fields
}

func (CreateBooleanAttributeOptions) New 

func (options CreateBooleanAttributeOptions) New() *CreateBooleanAttributeOptions

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 CreateDatetimeAttributeOption 

type CreateDatetimeAttributeOption func(*CreateDatetimeAttributeOptions)

type CreateDatetimeAttributeOptions 

type CreateDatetimeAttributeOptions struct {
	Default string
	Array   bool
	// contains filtered or unexported fields
}

func (CreateDatetimeAttributeOptions) New 

func (options CreateDatetimeAttributeOptions) New() *CreateDatetimeAttributeOptions

type CreateDocumentOption 

type CreateDocumentOption func(*CreateDocumentOptions)

type CreateDocumentOptions 

type CreateDocumentOptions struct {
	Permissions []string
	// contains filtered or unexported fields
}

func (CreateDocumentOptions) New 

func (options CreateDocumentOptions) New() *CreateDocumentOptions

type CreateEmailAttributeOption 

type CreateEmailAttributeOption func(*CreateEmailAttributeOptions)

type CreateEmailAttributeOptions 

type CreateEmailAttributeOptions struct {
	Default string
	Array   bool
	// contains filtered or unexported fields
}

func (CreateEmailAttributeOptions) New 

func (options CreateEmailAttributeOptions) New() *CreateEmailAttributeOptions

type CreateEnumAttributeOption 

type CreateEnumAttributeOption func(*CreateEnumAttributeOptions)

type CreateEnumAttributeOptions 

type CreateEnumAttributeOptions struct {
	Default string
	Array   bool
	// contains filtered or unexported fields
}

func (CreateEnumAttributeOptions) New 

func (options CreateEnumAttributeOptions) New() *CreateEnumAttributeOptions

type CreateFloatAttributeOption 

type CreateFloatAttributeOption func(*CreateFloatAttributeOptions)

type CreateFloatAttributeOptions 

type CreateFloatAttributeOptions struct {
	Min     float64
	Max     float64
	Default float64
	Array   bool
	// contains filtered or unexported fields
}

func (CreateFloatAttributeOptions) New 

func (options CreateFloatAttributeOptions) New() *CreateFloatAttributeOptions

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 CreateIntegerAttributeOption 

type CreateIntegerAttributeOption func(*CreateIntegerAttributeOptions)

type CreateIntegerAttributeOptions 

type CreateIntegerAttributeOptions struct {
	Min     int
	Max     int
	Default int
	Array   bool
	// contains filtered or unexported fields
}

func (CreateIntegerAttributeOptions) New 

func (options CreateIntegerAttributeOptions) New() *CreateIntegerAttributeOptions

type CreateIpAttributeOption 

type CreateIpAttributeOption func(*CreateIpAttributeOptions)

type CreateIpAttributeOptions 

type CreateIpAttributeOptions struct {
	Default string
	Array   bool
	// contains filtered or unexported fields
}

func (CreateIpAttributeOptions) New 

func (options CreateIpAttributeOptions) New() *CreateIpAttributeOptions

type CreateOption 

type CreateOption func(*CreateOptions)

type CreateOptions 

type CreateOptions struct {
	Enabled bool
	// contains filtered or unexported fields
}

func (CreateOptions) New 

func (options CreateOptions) New() *CreateOptions

type CreateRelationshipAttributeOption 

type CreateRelationshipAttributeOption func(*CreateRelationshipAttributeOptions)

type CreateRelationshipAttributeOptions 

type CreateRelationshipAttributeOptions struct {
	TwoWay    bool
	Key       string
	TwoWayKey string
	OnDelete  string
	// contains filtered or unexported fields
}

func (CreateRelationshipAttributeOptions) New 

func (options CreateRelationshipAttributeOptions) New() *CreateRelationshipAttributeOptions

type CreateStringAttributeOption 

type CreateStringAttributeOption func(*CreateStringAttributeOptions)

type CreateStringAttributeOptions 

type CreateStringAttributeOptions struct {
	Default string
	Array   bool
	Encrypt bool
	// contains filtered or unexported fields
}

func (CreateStringAttributeOptions) New 

func (options CreateStringAttributeOptions) New() *CreateStringAttributeOptions

type CreateUrlAttributeOption 

type CreateUrlAttributeOption func(*CreateUrlAttributeOptions)

type CreateUrlAttributeOptions 

type CreateUrlAttributeOptions struct {
	Default string
	Array   bool
	// contains filtered or unexported fields
}

func (CreateUrlAttributeOptions) New 

func (options CreateUrlAttributeOptions) New() *CreateUrlAttributeOptions

type Databases 

type Databases struct {
	// contains filtered or unexported fields
}

Databases service

func New 

func New(clt client.Client) *Databases

func (*Databases) Create 

func (srv *Databases) Create(DatabaseId string, Name string, optionalSetters ...CreateOption) (*models.Database, error)

Create create a new Database.

func (*Databases) CreateBooleanAttribute 

func (srv *Databases) CreateBooleanAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateBooleanAttributeOption) (*models.AttributeBoolean, error)

CreateBooleanAttribute create a boolean attribute.

func (*Databases) CreateCollection 

func (srv *Databases) CreateCollection(DatabaseId string, CollectionId string, Name string, optionalSetters ...CreateCollectionOption) (*models.Collection, 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#databasesCreateCollection) API or directly from your database console.

func (*Databases) CreateDatetimeAttribute 

func (srv *Databases) CreateDatetimeAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateDatetimeAttributeOption) (*models.AttributeDatetime, error)

CreateDatetimeAttribute create a date time attribute according to the ISO 8601 standard.

func (*Databases) CreateDocument 

func (srv *Databases) 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#databasesCreateCollection) API or directly from your database console.

func (*Databases) CreateDocuments added in v0.7.0 

func (srv *Databases) CreateDocuments(DatabaseId string, CollectionId string, Documents []interface{}) (*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#databasesCreateCollection) API or directly from your database console.

func (*Databases) CreateEmailAttribute 

func (srv *Databases) CreateEmailAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateEmailAttributeOption) (*models.AttributeEmail, error)

CreateEmailAttribute create an email attribute.

func (*Databases) CreateEnumAttribute 

func (srv *Databases) CreateEnumAttribute(DatabaseId string, CollectionId string, Key string, Elements []string, Required bool, optionalSetters ...CreateEnumAttributeOption) (*models.AttributeEnum, error)

CreateEnumAttribute create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.

func (*Databases) CreateFloatAttribute 

func (srv *Databases) CreateFloatAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateFloatAttributeOption) (*models.AttributeFloat, error)

CreateFloatAttribute create a float attribute. Optionally, minimum and maximum values can be provided.

func (*Databases) CreateIndex 

func (srv *Databases) 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 (*Databases) CreateIntegerAttribute 

func (srv *Databases) CreateIntegerAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateIntegerAttributeOption) (*models.AttributeInteger, error)

CreateIntegerAttribute create an integer attribute. Optionally, minimum and maximum values can be provided.

func (*Databases) CreateIpAttribute 

func (srv *Databases) CreateIpAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateIpAttributeOption) (*models.AttributeIp, error)

CreateIpAttribute create IP address attribute.

func (*Databases) CreateRelationshipAttribute 

func (srv *Databases) CreateRelationshipAttribute(DatabaseId string, CollectionId string, RelatedCollectionId string, Type string, optionalSetters ...CreateRelationshipAttributeOption) (*models.AttributeRelationship, error)

CreateRelationshipAttribute create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).

func (*Databases) CreateStringAttribute 

func (srv *Databases) CreateStringAttribute(DatabaseId string, CollectionId string, Key string, Size int, Required bool, optionalSetters ...CreateStringAttributeOption) (*models.AttributeString, error)

CreateStringAttribute create a string attribute.

func (*Databases) CreateUrlAttribute 

func (srv *Databases) CreateUrlAttribute(DatabaseId string, CollectionId string, Key string, Required bool, optionalSetters ...CreateUrlAttributeOption) (*models.AttributeUrl, error)

CreateUrlAttribute create a URL attribute.

func (*Databases) Delete 

func (srv *Databases) Delete(DatabaseId string) (*interface{}, error)

Delete delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.

func (*Databases) DeleteAttribute 

func (srv *Databases) DeleteAttribute(DatabaseId string, CollectionId string, Key string) (*interface{}, error)

DeleteAttribute deletes an attribute.

func (*Databases) DeleteCollection 

func (srv *Databases) 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 (*Databases) DeleteDocument 

func (srv *Databases) DeleteDocument(DatabaseId string, CollectionId string, DocumentId string) (*interface{}, error)

DeleteDocument delete a document by its unique ID.

func (*Databases) DeleteDocuments added in v0.7.0 

func (srv *Databases) 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 (*Databases) DeleteIndex 

func (srv *Databases) DeleteIndex(DatabaseId string, CollectionId string, Key string) (*interface{}, error)

DeleteIndex delete an index.

func (*Databases) Get 

func (srv *Databases) Get(DatabaseId string) (*models.Database, error)

Get get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.

func (*Databases) GetAttribute 

func (srv *Databases) GetAttribute(DatabaseId string, CollectionId string, Key string) (*interface{}, error)

GetAttribute get attribute by ID.

func (*Databases) GetCollection 

func (srv *Databases) GetCollection(DatabaseId string, CollectionId string) (*models.Collection, error)

GetCollection get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.

func (*Databases) GetDocument 

func (srv *Databases) 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 (*Databases) GetIndex 

func (srv *Databases) GetIndex(DatabaseId string, CollectionId string, Key string) (*models.Index, error)

GetIndex get index by ID.

func (*Databases) List 

func (srv *Databases) 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 (*Databases) ListAttributes 

func (srv *Databases) ListAttributes(DatabaseId string, CollectionId string, optionalSetters ...ListAttributesOption) (*models.AttributeList, error)

ListAttributes list attributes in the collection.

func (*Databases) ListCollections 

func (srv *Databases) ListCollections(DatabaseId string, optionalSetters ...ListCollectionsOption) (*models.CollectionList, 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 (*Databases) ListDocuments 

func (srv *Databases) 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 (*Databases) ListIndexes 

func (srv *Databases) ListIndexes(DatabaseId string, CollectionId string, optionalSetters ...ListIndexesOption) (*models.IndexList, error)

ListIndexes list indexes in the collection.

func (*Databases) Update 

func (srv *Databases) Update(DatabaseId string, Name string, optionalSetters ...UpdateOption) (*models.Database, error)

Update update a database by its unique ID.

func (*Databases) UpdateBooleanAttribute 

func (srv *Databases) UpdateBooleanAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default bool, optionalSetters ...UpdateBooleanAttributeOption) (*models.AttributeBoolean, error)

UpdateBooleanAttribute update a boolean attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateCollection 

func (srv *Databases) UpdateCollection(DatabaseId string, CollectionId string, Name string, optionalSetters ...UpdateCollectionOption) (*models.Collection, error)

UpdateCollection update a collection by its unique ID.

func (*Databases) UpdateDatetimeAttribute 

func (srv *Databases) UpdateDatetimeAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default string, optionalSetters ...UpdateDatetimeAttributeOption) (*models.AttributeDatetime, error)

UpdateDatetimeAttribute update a date time attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateDocument 

func (srv *Databases) 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 (*Databases) UpdateDocuments added in v0.7.0 

func (srv *Databases) 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 (*Databases) UpdateEmailAttribute 

func (srv *Databases) UpdateEmailAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default string, optionalSetters ...UpdateEmailAttributeOption) (*models.AttributeEmail, error)

UpdateEmailAttribute update an email attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateEnumAttribute 

func (srv *Databases) UpdateEnumAttribute(DatabaseId string, CollectionId string, Key string, Elements []string, Required bool, Default string, optionalSetters ...UpdateEnumAttributeOption) (*models.AttributeEnum, error)

UpdateEnumAttribute update an enum attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateFloatAttribute 

func (srv *Databases) UpdateFloatAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default float64, optionalSetters ...UpdateFloatAttributeOption) (*models.AttributeFloat, error)

UpdateFloatAttribute update a float attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateIntegerAttribute 

func (srv *Databases) UpdateIntegerAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default int, optionalSetters ...UpdateIntegerAttributeOption) (*models.AttributeInteger, error)

UpdateIntegerAttribute update an integer attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateIpAttribute 

func (srv *Databases) UpdateIpAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default string, optionalSetters ...UpdateIpAttributeOption) (*models.AttributeIp, error)

UpdateIpAttribute update an ip attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateRelationshipAttribute 

func (srv *Databases) UpdateRelationshipAttribute(DatabaseId string, CollectionId string, Key string, optionalSetters ...UpdateRelationshipAttributeOption) (*models.AttributeRelationship, error)

UpdateRelationshipAttribute update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).

func (*Databases) UpdateStringAttribute 

func (srv *Databases) UpdateStringAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default string, optionalSetters ...UpdateStringAttributeOption) (*models.AttributeString, error)

UpdateStringAttribute update a string attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpdateUrlAttribute 

func (srv *Databases) UpdateUrlAttribute(DatabaseId string, CollectionId string, Key string, Required bool, Default string, optionalSetters ...UpdateUrlAttributeOption) (*models.AttributeUrl, error)

UpdateUrlAttribute update an url attribute. Changing the `default` value will not update already existing documents.

func (*Databases) UpsertDocuments added in v0.7.0 

func (srv *Databases) UpsertDocuments(DatabaseId string, CollectionId string, 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#databasesCreateCollection) API or directly from your database console.

func (*Databases) WithCreateBooleanAttributeArray 

func (srv *Databases) WithCreateBooleanAttributeArray(v bool) CreateBooleanAttributeOption

func (*Databases) WithCreateBooleanAttributeDefault 

func (srv *Databases) WithCreateBooleanAttributeDefault(v bool) CreateBooleanAttributeOption

func (*Databases) WithCreateCollectionDocumentSecurity 

func (srv *Databases) WithCreateCollectionDocumentSecurity(v bool) CreateCollectionOption

func (*Databases) WithCreateCollectionEnabled 

func (srv *Databases) WithCreateCollectionEnabled(v bool) CreateCollectionOption

func (*Databases) WithCreateCollectionPermissions 

func (srv *Databases) WithCreateCollectionPermissions(v []string) CreateCollectionOption

func (*Databases) WithCreateDatetimeAttributeArray 

func (srv *Databases) WithCreateDatetimeAttributeArray(v bool) CreateDatetimeAttributeOption

func (*Databases) WithCreateDatetimeAttributeDefault 

func (srv *Databases) WithCreateDatetimeAttributeDefault(v string) CreateDatetimeAttributeOption

func (*Databases) WithCreateDocumentPermissions 

func (srv *Databases) WithCreateDocumentPermissions(v []string) CreateDocumentOption

func (*Databases) WithCreateEmailAttributeArray 

func (srv *Databases) WithCreateEmailAttributeArray(v bool) CreateEmailAttributeOption

func (*Databases) WithCreateEmailAttributeDefault 

func (srv *Databases) WithCreateEmailAttributeDefault(v string) CreateEmailAttributeOption

func (*Databases) WithCreateEnabled 

func (srv *Databases) WithCreateEnabled(v bool) CreateOption

func (*Databases) WithCreateEnumAttributeArray 

func (srv *Databases) WithCreateEnumAttributeArray(v bool) CreateEnumAttributeOption

func (*Databases) WithCreateEnumAttributeDefault 

func (srv *Databases) WithCreateEnumAttributeDefault(v string) CreateEnumAttributeOption

func (*Databases) WithCreateFloatAttributeArray 

func (srv *Databases) WithCreateFloatAttributeArray(v bool) CreateFloatAttributeOption

func (*Databases) WithCreateFloatAttributeDefault 

func (srv *Databases) WithCreateFloatAttributeDefault(v float64) CreateFloatAttributeOption

func (*Databases) WithCreateFloatAttributeMax 

func (srv *Databases) WithCreateFloatAttributeMax(v float64) CreateFloatAttributeOption

func (*Databases) WithCreateFloatAttributeMin 

func (srv *Databases) WithCreateFloatAttributeMin(v float64) CreateFloatAttributeOption

func (*Databases) WithCreateIndexLengths added in v0.7.0 

func (srv *Databases) WithCreateIndexLengths(v []int) CreateIndexOption

func (*Databases) WithCreateIndexOrders 

func (srv *Databases) WithCreateIndexOrders(v []string) CreateIndexOption

func (*Databases) WithCreateIntegerAttributeArray 

func (srv *Databases) WithCreateIntegerAttributeArray(v bool) CreateIntegerAttributeOption

func (*Databases) WithCreateIntegerAttributeDefault 

func (srv *Databases) WithCreateIntegerAttributeDefault(v int) CreateIntegerAttributeOption

func (*Databases) WithCreateIntegerAttributeMax 

func (srv *Databases) WithCreateIntegerAttributeMax(v int) CreateIntegerAttributeOption

func (*Databases) WithCreateIntegerAttributeMin 

func (srv *Databases) WithCreateIntegerAttributeMin(v int) CreateIntegerAttributeOption

func (*Databases) WithCreateIpAttributeArray 

func (srv *Databases) WithCreateIpAttributeArray(v bool) CreateIpAttributeOption

func (*Databases) WithCreateIpAttributeDefault 

func (srv *Databases) WithCreateIpAttributeDefault(v string) CreateIpAttributeOption

func (*Databases) WithCreateRelationshipAttributeKey 

func (srv *Databases) WithCreateRelationshipAttributeKey(v string) CreateRelationshipAttributeOption

func (*Databases) WithCreateRelationshipAttributeOnDelete 

func (srv *Databases) WithCreateRelationshipAttributeOnDelete(v string) CreateRelationshipAttributeOption

func (*Databases) WithCreateRelationshipAttributeTwoWay 

func (srv *Databases) WithCreateRelationshipAttributeTwoWay(v bool) CreateRelationshipAttributeOption

func (*Databases) WithCreateRelationshipAttributeTwoWayKey 

func (srv *Databases) WithCreateRelationshipAttributeTwoWayKey(v string) CreateRelationshipAttributeOption

func (*Databases) WithCreateStringAttributeArray 

func (srv *Databases) WithCreateStringAttributeArray(v bool) CreateStringAttributeOption

func (*Databases) WithCreateStringAttributeDefault 

func (srv *Databases) WithCreateStringAttributeDefault(v string) CreateStringAttributeOption

func (*Databases) WithCreateStringAttributeEncrypt 

func (srv *Databases) WithCreateStringAttributeEncrypt(v bool) CreateStringAttributeOption

func (*Databases) WithCreateUrlAttributeArray 

func (srv *Databases) WithCreateUrlAttributeArray(v bool) CreateUrlAttributeOption

func (*Databases) WithCreateUrlAttributeDefault 

func (srv *Databases) WithCreateUrlAttributeDefault(v string) CreateUrlAttributeOption

func (*Databases) WithDeleteDocumentsQueries added in v0.7.0 

func (srv *Databases) WithDeleteDocumentsQueries(v []string) DeleteDocumentsOption

func (*Databases) WithGetDocumentQueries 

func (srv *Databases) WithGetDocumentQueries(v []string) GetDocumentOption

func (*Databases) WithListAttributesQueries 

func (srv *Databases) WithListAttributesQueries(v []string) ListAttributesOption

func (*Databases) WithListCollectionsQueries 

func (srv *Databases) WithListCollectionsQueries(v []string) ListCollectionsOption

func (*Databases) WithListCollectionsSearch 

func (srv *Databases) WithListCollectionsSearch(v string) ListCollectionsOption

func (*Databases) WithListDocumentsQueries 

func (srv *Databases) WithListDocumentsQueries(v []string) ListDocumentsOption

func (*Databases) WithListIndexesQueries 

func (srv *Databases) WithListIndexesQueries(v []string) ListIndexesOption

func (*Databases) WithListQueries 

func (srv *Databases) WithListQueries(v []string) ListOption

func (*Databases) WithListSearch 

func (srv *Databases) WithListSearch(v string) ListOption

func (*Databases) WithUpdateBooleanAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateBooleanAttributeNewKey(v string) UpdateBooleanAttributeOption

func (*Databases) WithUpdateCollectionDocumentSecurity 

func (srv *Databases) WithUpdateCollectionDocumentSecurity(v bool) UpdateCollectionOption

func (*Databases) WithUpdateCollectionEnabled 

func (srv *Databases) WithUpdateCollectionEnabled(v bool) UpdateCollectionOption

func (*Databases) WithUpdateCollectionPermissions 

func (srv *Databases) WithUpdateCollectionPermissions(v []string) UpdateCollectionOption

func (*Databases) WithUpdateDatetimeAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateDatetimeAttributeNewKey(v string) UpdateDatetimeAttributeOption

func (*Databases) WithUpdateDocumentData 

func (srv *Databases) WithUpdateDocumentData(v interface{}) UpdateDocumentOption

func (*Databases) WithUpdateDocumentPermissions 

func (srv *Databases) WithUpdateDocumentPermissions(v []string) UpdateDocumentOption

func (*Databases) WithUpdateDocumentsData added in v0.7.0 

func (srv *Databases) WithUpdateDocumentsData(v interface{}) UpdateDocumentsOption

func (*Databases) WithUpdateDocumentsQueries added in v0.7.0 

func (srv *Databases) WithUpdateDocumentsQueries(v []string) UpdateDocumentsOption

func (*Databases) WithUpdateEmailAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateEmailAttributeNewKey(v string) UpdateEmailAttributeOption

func (*Databases) WithUpdateEnabled 

func (srv *Databases) WithUpdateEnabled(v bool) UpdateOption

func (*Databases) WithUpdateEnumAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateEnumAttributeNewKey(v string) UpdateEnumAttributeOption

func (*Databases) WithUpdateFloatAttributeMax added in v0.7.0 

func (srv *Databases) WithUpdateFloatAttributeMax(v float64) UpdateFloatAttributeOption

func (*Databases) WithUpdateFloatAttributeMin added in v0.7.0 

func (srv *Databases) WithUpdateFloatAttributeMin(v float64) UpdateFloatAttributeOption

func (*Databases) WithUpdateFloatAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateFloatAttributeNewKey(v string) UpdateFloatAttributeOption

func (*Databases) WithUpdateIntegerAttributeMax added in v0.7.0 

func (srv *Databases) WithUpdateIntegerAttributeMax(v int) UpdateIntegerAttributeOption

func (*Databases) WithUpdateIntegerAttributeMin added in v0.7.0 

func (srv *Databases) WithUpdateIntegerAttributeMin(v int) UpdateIntegerAttributeOption

func (*Databases) WithUpdateIntegerAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateIntegerAttributeNewKey(v string) UpdateIntegerAttributeOption

func (*Databases) WithUpdateIpAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateIpAttributeNewKey(v string) UpdateIpAttributeOption

func (*Databases) WithUpdateRelationshipAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateRelationshipAttributeNewKey(v string) UpdateRelationshipAttributeOption

func (*Databases) WithUpdateRelationshipAttributeOnDelete 

func (srv *Databases) WithUpdateRelationshipAttributeOnDelete(v string) UpdateRelationshipAttributeOption

func (*Databases) WithUpdateStringAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateStringAttributeNewKey(v string) UpdateStringAttributeOption

func (*Databases) WithUpdateStringAttributeSize added in v0.2.0 

func (srv *Databases) WithUpdateStringAttributeSize(v int) UpdateStringAttributeOption

func (*Databases) WithUpdateUrlAttributeNewKey added in v0.2.0 

func (srv *Databases) WithUpdateUrlAttributeNewKey(v string) UpdateUrlAttributeOption

func (*Databases) WithUpsertDocumentsDocuments added in v0.7.0 

func (srv *Databases) WithUpsertDocumentsDocuments(v []interface{}) UpsertDocumentsOption

type DeleteDocumentsOption added in v0.7.0 

type DeleteDocumentsOption func(*DeleteDocumentsOptions)

type DeleteDocumentsOptions added in v0.7.0 

type DeleteDocumentsOptions struct {
	Queries []string
	// contains filtered or unexported fields
}

func (DeleteDocumentsOptions) New added in v0.7.0 

func (options DeleteDocumentsOptions) New() *DeleteDocumentsOptions

type GetDocumentOption 

type GetDocumentOption func(*GetDocumentOptions)

type GetDocumentOptions 

type GetDocumentOptions struct {
	Queries []string
	// contains filtered or unexported fields
}

func (GetDocumentOptions) New 

func (options GetDocumentOptions) New() *GetDocumentOptions

type ListAttributesOption 

type ListAttributesOption func(*ListAttributesOptions)

type ListAttributesOptions 

type ListAttributesOptions struct {
	Queries []string
	// contains filtered or unexported fields
}

func (ListAttributesOptions) New 

func (options ListAttributesOptions) New() *ListAttributesOptions

type ListCollectionsOption 

type ListCollectionsOption func(*ListCollectionsOptions)

type ListCollectionsOptions 

type ListCollectionsOptions struct {
	Queries []string
	Search  string
	// 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
	// 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
	// contains filtered or unexported fields
}

func (ListIndexesOptions) New 

func (options ListIndexesOptions) New() *ListIndexesOptions

type ListOption 

type ListOption func(*ListOptions)

type ListOptions 

type ListOptions struct {
	Queries []string
	Search  string
	// contains filtered or unexported fields
}

func (ListOptions) New 

func (options ListOptions) New() *ListOptions

type UpdateBooleanAttributeOption added in v0.2.0 

type UpdateBooleanAttributeOption func(*UpdateBooleanAttributeOptions)

type UpdateBooleanAttributeOptions added in v0.2.0 

type UpdateBooleanAttributeOptions struct {
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateBooleanAttributeOptions) New added in v0.2.0 

func (options UpdateBooleanAttributeOptions) New() *UpdateBooleanAttributeOptions

type UpdateCollectionOption 

type UpdateCollectionOption func(*UpdateCollectionOptions)

type UpdateCollectionOptions 

type UpdateCollectionOptions struct {
	Permissions      []string
	DocumentSecurity bool
	Enabled          bool
	// contains filtered or unexported fields
}

func (UpdateCollectionOptions) New 

func (options UpdateCollectionOptions) New() *UpdateCollectionOptions

type UpdateDatetimeAttributeOption added in v0.2.0 

type UpdateDatetimeAttributeOption func(*UpdateDatetimeAttributeOptions)

type UpdateDatetimeAttributeOptions added in v0.2.0 

type UpdateDatetimeAttributeOptions struct {
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateDatetimeAttributeOptions) New added in v0.2.0 

func (options UpdateDatetimeAttributeOptions) New() *UpdateDatetimeAttributeOptions

type UpdateDocumentOption 

type UpdateDocumentOption func(*UpdateDocumentOptions)

type UpdateDocumentOptions 

type UpdateDocumentOptions struct {
	Data        interface{}
	Permissions []string
	// contains filtered or unexported fields
}

func (UpdateDocumentOptions) New 

func (options UpdateDocumentOptions) New() *UpdateDocumentOptions

type UpdateDocumentsOption added in v0.7.0 

type UpdateDocumentsOption func(*UpdateDocumentsOptions)

type UpdateDocumentsOptions added in v0.7.0 

type UpdateDocumentsOptions struct {
	Data    interface{}
	Queries []string
	// contains filtered or unexported fields
}

func (UpdateDocumentsOptions) New added in v0.7.0 

func (options UpdateDocumentsOptions) New() *UpdateDocumentsOptions

type UpdateEmailAttributeOption added in v0.2.0 

type UpdateEmailAttributeOption func(*UpdateEmailAttributeOptions)

type UpdateEmailAttributeOptions added in v0.2.0 

type UpdateEmailAttributeOptions struct {
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateEmailAttributeOptions) New added in v0.2.0 

func (options UpdateEmailAttributeOptions) New() *UpdateEmailAttributeOptions

type UpdateEnumAttributeOption added in v0.2.0 

type UpdateEnumAttributeOption func(*UpdateEnumAttributeOptions)

type UpdateEnumAttributeOptions added in v0.2.0 

type UpdateEnumAttributeOptions struct {
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateEnumAttributeOptions) New added in v0.2.0 

func (options UpdateEnumAttributeOptions) New() *UpdateEnumAttributeOptions

type UpdateFloatAttributeOption added in v0.2.0 

type UpdateFloatAttributeOption func(*UpdateFloatAttributeOptions)

type UpdateFloatAttributeOptions added in v0.2.0 

type UpdateFloatAttributeOptions struct {
	Min    float64
	Max    float64
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateFloatAttributeOptions) New added in v0.2.0 

func (options UpdateFloatAttributeOptions) New() *UpdateFloatAttributeOptions

type UpdateIntegerAttributeOption added in v0.2.0 

type UpdateIntegerAttributeOption func(*UpdateIntegerAttributeOptions)

type UpdateIntegerAttributeOptions added in v0.2.0 

type UpdateIntegerAttributeOptions struct {
	Min    int
	Max    int
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateIntegerAttributeOptions) New added in v0.2.0 

func (options UpdateIntegerAttributeOptions) New() *UpdateIntegerAttributeOptions

type UpdateIpAttributeOption added in v0.2.0 

type UpdateIpAttributeOption func(*UpdateIpAttributeOptions)

type UpdateIpAttributeOptions added in v0.2.0 

type UpdateIpAttributeOptions struct {
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateIpAttributeOptions) New added in v0.2.0 

func (options UpdateIpAttributeOptions) New() *UpdateIpAttributeOptions

type UpdateOption 

type UpdateOption func(*UpdateOptions)

type UpdateOptions 

type UpdateOptions struct {
	Enabled bool
	// contains filtered or unexported fields
}

func (UpdateOptions) New 

func (options UpdateOptions) New() *UpdateOptions

type UpdateRelationshipAttributeOption 

type UpdateRelationshipAttributeOption func(*UpdateRelationshipAttributeOptions)

type UpdateRelationshipAttributeOptions 

type UpdateRelationshipAttributeOptions struct {
	OnDelete string
	NewKey   string
	// contains filtered or unexported fields
}

func (UpdateRelationshipAttributeOptions) New 

func (options UpdateRelationshipAttributeOptions) New() *UpdateRelationshipAttributeOptions

type UpdateStringAttributeOption added in v0.2.0 

type UpdateStringAttributeOption func(*UpdateStringAttributeOptions)

type UpdateStringAttributeOptions added in v0.2.0 

type UpdateStringAttributeOptions struct {
	Size   int
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateStringAttributeOptions) New added in v0.2.0 

func (options UpdateStringAttributeOptions) New() *UpdateStringAttributeOptions

type UpdateUrlAttributeOption added in v0.2.0 

type UpdateUrlAttributeOption func(*UpdateUrlAttributeOptions)

type UpdateUrlAttributeOptions added in v0.2.0 

type UpdateUrlAttributeOptions struct {
	NewKey string
	// contains filtered or unexported fields
}

func (UpdateUrlAttributeOptions) New added in v0.2.0 

func (options UpdateUrlAttributeOptions) New() *UpdateUrlAttributeOptions

type UpsertDocumentsOption added in v0.7.0 

type UpsertDocumentsOption func(*UpsertDocumentsOptions)

type UpsertDocumentsOptions added in v0.7.0 

type UpsertDocumentsOptions struct {
	Documents []interface{}
	// contains filtered or unexported fields
}

func (UpsertDocumentsOptions) New added in v0.7.0 

func (options UpsertDocumentsOptions) New() *UpsertDocumentsOptions

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.