driver

type AppKey api.AppKey

type CRUDWithOptions interface {
	// contains filtered or unexported methods
}

type Collation api.Collation

type CollectionOptions api.CollectionOptions

type CreateBranchResponse api.CreateBranchResponse

type CreateCollectionOptions struct {
	OnlyCreate bool
}

type CreateOrUpdateCollectionsResponse api.CreateOrUpdateCollectionsResponse

type CreateProjectOptions struct{}

type CreateProjectResponse api.CreateProjectResponse

type Database interface {
	// BeginTx starts new transaction
	BeginTx(ctx context.Context, options ...*TxOptions) (Tx, error)
	// Insert array of documents into specified database and collection.
	Insert(ctx context.Context, collection string, docs []Document,
		options ...*InsertOptions) (*InsertResponse, error)

	// Replace array of documents into specified database and collection
	// Creates document if it doesn't exist.
	Replace(ctx context.Context, collection string, docs []Document,
		options ...*ReplaceOptions) (*ReplaceResponse, error)

	// Read documents from the collection matching the specified filter.
	Read(ctx context.Context, collection string, filter Filter, fields Projection,
		options ...*ReadOptions) (Iterator, error)

	// Explain the query planner for a specified filter.
	Explain(ctx context.Context, collection string, filter Filter, fields Projection,
		options ...*ReadOptions) (*ExplainResponse, error)

	// Search for documents in the collection matching specified query
	Search(ctx context.Context, collection string, request *SearchRequest) (SearchResultIterator, error)

	// Update documents in the collection matching the specified filter.
	Update(ctx context.Context, collection string, filter Filter, fields Update,
		options ...*UpdateOptions) (*UpdateResponse, error)

	// Delete documents from the collection matching specified filter.
	Delete(ctx context.Context, collection string, filter Filter, options ...*DeleteOptions) (*DeleteResponse, error)

	Count(ctx context.Context, collection string, filter Filter) (int64, error)

	// CreateOrUpdateCollection either creates a collection or update the collection with the new schema
	// There are three categories of data types supported:
	//   Primitive: Strings, Numbers, Binary Data, Booleans, UUIDs, DateTime
	//   Complex: Arrays
	//   Objects: A container data type defined by the user that stores fields of primitive types,
	//   complex types as well as other Objects
	//
	//  The data types are derived from the types defined in the JSON schema specification
	//  with extensions that enable support for richer semantics.
	//  As an example, the string is defined like this,
	//   {
	//     "name": {
	//       "type": "string"
	//     }
	//   }
	// More detailed information here: https://docs.tigrisdata.com/datamodels/types
	CreateOrUpdateCollection(ctx context.Context, collection string, schema Schema,
		options ...*CreateCollectionOptions) error

	// CreateOrUpdateCollections creates batch of collections
	CreateOrUpdateCollections(ctx context.Context, schema []Schema, options ...*CreateCollectionOptions) (*CreateOrUpdateCollectionsResponse, error)

	// DropCollection deletes the collection and all documents it contains.
	DropCollection(ctx context.Context, collection string, options ...*CollectionOptions) error

	// DropAllCollections deletes all the collections and all documents it contains.
	DropAllCollections(ctx context.Context, options ...*CollectionOptions) error

	// ListCollections lists collections in the database.
	ListCollections(ctx context.Context, options ...*CollectionOptions) ([]string, error)

	// DescribeCollection returns metadata of the collection in the database
	DescribeCollection(ctx context.Context, collection string, options ...*DescribeCollectionOptions) (
		*DescribeCollectionResponse, error)

	// CreateBranch creates a branch of this database
	CreateBranch(ctx context.Context, name string) (*CreateBranchResponse, error)

	// DeleteBranch deletes a branch of this database, throws an error if "main" branch is being deleted
	DeleteBranch(ctx context.Context, name string) (*DeleteBranchResponse, error)
}

type DeleteBranchResponse api.DeleteBranchResponse

type DeleteOptions api.DeleteRequestOptions

type DeleteProjectOptions struct{}

type DeleteProjectResponse api.DeleteProjectResponse

type DeleteResponse api.DeleteResponse

type DescribeCollectionOptions struct {
	SchemaFormat string
}

type DescribeCollectionResponse api.DescribeCollectionResponse

type DescribeDatabaseResponse api.DescribeDatabaseResponse

type DescribeProjectOptions struct {
	SchemaFormat string
}

type DocStatus = api.DocStatus

type Document json.RawMessage

type Driver interface {
	// Info returns server information
	Info(ctx context.Context) (*InfoResponse, error)
	// Health returns server health
	Health(ctx context.Context) (*HealthResponse, error)

	// UseDatabase returns and interface for collections and documents management
	// of the database
	UseDatabase(project string) Database
	UseSearch(project string) SearchClient

	// CreateProject creates the project
	CreateProject(ctx context.Context, project string, options ...*CreateProjectOptions) (*CreateProjectResponse, error)

	// DescribeDatabase returns project description metadata
	DescribeDatabase(ctx context.Context, project string, options ...*DescribeProjectOptions) (*DescribeDatabaseResponse, error)

	// ListProjects returns all projects
	ListProjects(ctx context.Context) ([]string, error)

	// DeleteProject deletes the project
	DeleteProject(ctx context.Context, project string, options ...*DeleteProjectOptions) (*DeleteProjectResponse, error)

	// Close releases resources of the driver
	Close() error

	CreateAppKey(ctx context.Context, project string, name string, description string) (*AppKey, error)
	DeleteAppKey(ctx context.Context, project string, id string) error
	UpdateAppKey(ctx context.Context, project string, id string, name string, description string) (*AppKey, error)
	ListAppKeys(ctx context.Context, project string) ([]*AppKey, error)
	RotateAppKeySecret(ctx context.Context, project string, id string) (*AppKey, error)

	CreateGlobalAppKey(ctx context.Context, name string, description string) (*GlobalAppKey, error)
	DeleteGlobalAppKey(ctx context.Context, id string) error
	UpdateGlobalAppKey(ctx context.Context, id string, name string, description string) (*GlobalAppKey, error)
	ListGlobalAppKeys(ctx context.Context) ([]*GlobalAppKey, error)
	RotateGlobalAppKeySecret(ctx context.Context, id string) (*GlobalAppKey, error)
}

type Error struct {
	*api.TigrisError
}

type ExplainResponse api.ExplainResponse

type Facet json.RawMessage

type Filter json.RawMessage

type GlobalAppKey api.GlobalAppKey

type HealthResponse api.HealthCheckResponse

type IndexInfo = api.IndexInfo

type IndexSource = api.IndexSource

type InfoResponse api.GetInfoResponse

type InsertOptions api.InsertRequestOptions

type InsertResponse api.InsertResponse

type Invitation api.Invitation

type InvitationInfo api.InvitationInfo

type Iterator interface {
	Next(d *Document) bool
	Err() error
	Close()
}

type JSONArrMatcher struct {
	T        *testing.T
	Expected []string
}

type JSONMatcher struct {
	T        *testing.T
	Expected []byte
}

type ListProjectsResponse api.ListProjectsResponse

type Management interface {
	GetAccessToken(ctx context.Context, clientID string, clientSecret string, refreshToken string) (*TokenResponse, error)

	CreateNamespace(ctx context.Context, name string) error
	ListNamespaces(ctx context.Context) ([]*Namespace, error)

	CreateInvitations(ctx context.Context, invitations []*InvitationInfo) error
	DeleteInvitations(ctx context.Context, email string, status string) error
	ListInvitations(ctx context.Context, status string) ([]*Invitation, error)
	VerifyInvitation(ctx context.Context, email string, code string) error
	ListUsers(ctx context.Context) ([]*User, error)

	Close() error
}

type Message json.RawMessage

type Namespace api.NamespaceInfo

type Observability interface {
	QuotaLimits(ctx context.Context) (*QuotaLimits, error)
	QuotaUsage(ctx context.Context) (*QuotaUsage, error)

	Close() error
}

type Projection json.RawMessage

type ProtoMatcher struct {
	Message proto.Message
}

type QuotaLimits api.QuotaLimitsResponse

type QuotaUsage api.QuotaUsageResponse

type ReadOptions struct {
	// Limit the number of documents returned by the read operation.
	Limit int64
	// Number of documents to skip before starting to return resulting documents.
	Skip int64
	// A cursor for use in pagination. The next streams will return documents after this offset.
	Offset []byte
	// Collation allows you to specify string comparison rules. Default is case-sensitive.
	Collation *api.Collation
	// Sort order
	Sort []byte
}

type ReplaceOptions api.ReplaceRequestOptions

type ReplaceResponse api.ReplaceResponse

type Schema json.RawMessage

type SearchClient interface {
	CreateOrUpdateIndex(ctx context.Context, name string, schema Schema) error
	GetIndex(ctx context.Context, name string) (*IndexInfo, error)
	DeleteIndex(ctx context.Context, name string) error
	ListIndexes(ctx context.Context, filter *IndexSource) ([]*IndexInfo, error)
	Get(ctx context.Context, name string, ids []string) ([]*SearchHit, error)
	CreateByID(ctx context.Context, name string, id string, doc Document) error
	Create(ctx context.Context, name string, docs []Document) ([]*DocStatus, error)
	CreateOrReplace(ctx context.Context, name string, docs []Document) ([]*DocStatus, error)
	Update(ctx context.Context, name string, docs []Document) ([]*DocStatus, error)
	Delete(ctx context.Context, name string, ids []string) ([]*DocStatus, error)
	DeleteByQuery(ctx context.Context, name string, filter Filter) (int32, error)
	Search(ctx context.Context, name string, req *SearchRequest) (SearchIndexResultIterator, error)
}

type SearchHit = api.SearchHit

type SearchIndexResponse = *api.SearchIndexResponse

type SearchIndexResultIterator interface {
	Next(r *SearchIndexResponse) bool
	Err() error
	Close()
}

type SearchRequest struct {
	Q             string
	SearchFields  []string
	Filter        Filter
	Facet         Facet
	Sort          SortOrder
	IncludeFields []string
	ExcludeFields []string
	Page          int32
	PageSize      int32
	Collation     *Collation
	Vector        Vector
}

type SearchResponse *api.SearchResponse

type SearchResultIterator interface {
	Next(r *SearchResponse) bool
	Err() error
	Close()
}

type SortOrder []json.RawMessage

type TokenResponse api.GetAccessTokenResponse

type Tx interface {
	// Commit all the modification of the transaction
	Commit(ctx context.Context) error

	// Rollback discard all the modification made by the transaction
	Rollback(ctx context.Context) error

	Database
}

type TxOptions api.TransactionOptions

type Update json.RawMessage

type UpdateOptions api.UpdateRequestOptions

type UpdateResponse api.UpdateResponse

type User api.User

type Vector json.RawMessage

type WriteOptions api.WriteOptions