arangodb

package

Go to main page

Versions in this module

v2

v2.1.5

Aug 31, 2025

Changes in this version

+ func RequiredFieldError(field string) error

+ type CacheRespObject struct

+ BindVars map[string]interface{}

+ DataSources *[]string

+ Hash *string

+ Hits *uint32

+ Query *string

type ClientFoxxService

+ CommitFoxxService func(ctx context.Context, dbName string, replace *bool) error

+ DisableDevelopmentMode func(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)

+ DownloadFoxxServiceBundle func(ctx context.Context, dbName string, mount *string) ([]byte, error)

+ EnableDevelopmentMode func(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)

+ GetFoxxServiceConfiguration func(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)

+ GetFoxxServiceDependencies func(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)

+ GetFoxxServiceReadme func(ctx context.Context, dbName string, mount *string) ([]byte, error)

+ GetFoxxServiceScripts func(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)

+ GetFoxxServiceSwagger func(ctx context.Context, dbName string, mount *string) (SwaggerResponse, error)

+ GetInstalledFoxxService func(ctx context.Context, dbName string, mount *string) (FoxxServiceObject, error)

+ ListInstalledFoxxServices func(ctx context.Context, dbName string, excludeSystem *bool) ([]FoxxServiceListItem, error)

+ ReplaceFoxxService func(ctx context.Context, dbName string, zipFile string, ...) error

+ ReplaceFoxxServiceConfiguration func(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)

+ ReplaceFoxxServiceDependencies func(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)

+ RunFoxxServiceScript func(ctx context.Context, dbName string, name string, mount *string, ...) (map[string]interface{}, error)

+ RunFoxxServiceTests func(ctx context.Context, dbName string, opt FoxxTestOptions) (map[string]interface{}, error)

+ UpdateFoxxServiceConfiguration func(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)

+ UpdateFoxxServiceDependencies func(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)

+ UpgradeFoxxService func(ctx context.Context, dbName string, zipFile string, ...) error

+ type ClientTasks interface

+ CreateTask func(ctx context.Context, databaseName string, options TaskOptions) (Task, error)

+ CreateTaskWithID func(ctx context.Context, databaseName string, id string, options TaskOptions) (Task, error)

+ RemoveTask func(ctx context.Context, databaseName string, id string) error

+ Task func(ctx context.Context, databaseName string, id string) (Task, error)

+ Tasks func(ctx context.Context, databaseName string) ([]Task, error)

type Collection

+ Checksum func(ctx context.Context, withRevisions *bool, withData *bool) (CollectionChecksum, error)

+ Compact func(ctx context.Context) (CollectionInfo, error)

+ LoadIndexesIntoMemory func(ctx context.Context) (bool, error)

+ RecalculateCount func(ctx context.Context) (bool, *int64, error)

+ Rename func(ctx context.Context, req RenameCollectionRequest) (CollectionInfo, error)

+ ResponsibleShard func(ctx context.Context, options map[string]interface{}) (string, error)

+ Revision func(ctx context.Context) (CollectionProperties, error)

+ Statistics func(ctx context.Context, details bool) (CollectionFigures, error)

+ type CollectionChecksum struct

+ Revision string

+ type CollectionFigures struct

type CollectionProperties

+ Revision string

+ type CommonFoxxServiceFields struct

+ Development *bool

+ Legacy *bool

+ Mount *string

+ Name *string

+ Version *string

+ type Contributor struct

+ Email *string

+ Name *string

type Database

+ KeyGenerators func(ctx context.Context) (KeyGeneratorsResponse, error)

type DatabaseQuery

+ ClearQueryCache func(ctx context.Context) error

+ ClearQueryPlanCache func(ctx context.Context) error

+ ClearSlowAQLQueries func(ctx context.Context, all *bool) error

+ CreateUserDefinedFunction func(ctx context.Context, options UserDefinedFunctionObject) (bool, error)

+ DeleteUserDefinedFunction func(ctx context.Context, name *string, group *bool) (*int, error)

+ GetAllOptimizerRules func(ctx context.Context) ([]OptimizerRules, error)

+ GetQueryCacheProperties func(ctx context.Context) (QueryCacheProperties, error)

+ GetQueryEntriesCache func(ctx context.Context) ([]QueryCacheEntriesRespObject, error)

+ GetQueryPlanCache func(ctx context.Context) ([]QueryPlanCacheRespObject, error)

+ GetQueryProperties func(ctx context.Context) (QueryProperties, error)

+ GetUserDefinedFunctions func(ctx context.Context) ([]UserDefinedFunctionObject, error)

+ KillAQLQuery func(ctx context.Context, queryId string, all *bool) error

+ ListOfRunningAQLQueries func(ctx context.Context, all *bool) ([]RunningAQLQuery, error)

+ ListOfSlowAQLQueries func(ctx context.Context, all *bool) ([]RunningAQLQuery, error)

+ SetQueryCacheProperties func(ctx context.Context, options QueryCacheProperties) (QueryCacheProperties, error)

+ UpdateQueryProperties func(ctx context.Context, options QueryProperties) (QueryProperties, error)

+ type DeployFoxxServiceRequest struct

+ type Engines struct

+ Arangodb *string

+ type Flags struct

+ CanBeDisabled *bool

+ CanCreateAdditionalPlans *bool

+ ClusterOnly *bool

+ DisabledByDefault *bool

+ EnterpriseOnly *bool

+ Hidden *bool

+ type FoxxDeploymentOptions struct

+ Mount *string

+ type FoxxServiceListItem struct

+ Provides map[string]interface{}

+ type FoxxServiceObject struct

+ Manifest *Manifest

+ Options map[string]interface{}

+ Path *string

+ type FoxxTestOptions struct

+ Filter *string

+ Idiomatic *bool

+ Reporter *string

+ type KeyGeneratorsResponse struct

+ KeyGenerators []string

+ type Manifest struct

+ Author *string

+ Configuration map[string]interface{}

+ Contributors []*Contributor

+ DefaultDocument *string

+ Dependencies map[string]interface{}

+ Description *string

+ Engines *Engines

+ Files map[string]interface{}

+ License *string

+ Main *string

+ Name *string

+ Repository *Repository

+ Schema *string

+ Scripts map[string]interface{}

+ Version *string

+ type OptimizerRules struct

+ Name string

+ type QueryCacheEntriesRespObject struct

+ Results *uint32

+ RunTime string

+ Size *uint64

+ Started *string

+ type QueryCacheProperties struct

+ IncludeSystem *bool

+ MaxEntrySize *uint64

+ MaxResults *uint16

+ MaxResultsSize *uint64

+ Mode *string

+ type QueryPlanCacheRespObject struct

+ Created *string

+ FullCount *bool

+ MemoryUsage *uint64

+ QueryHash *uint32

+ type QueryProperties struct

+ Enabled *bool

+ MaxQueryStringLength *int

+ MaxSlowQueries *int

+ SlowQueryThreshold *float64

+ TrackBindVars *bool

+ TrackSlowQueries *bool

+ type RenameCollectionRequest struct

+ Name string

+ type Repository struct

+ Type *string

+ URL *string

+ type ResponsibleShardRequest struct

+ Key string

+ type RunningAQLQuery struct

+ BindVars *map[string]interface{}

+ Database *string

+ Id *string

+ PeakMemoryUsage *uint64

+ Query *string

+ RunTime *float64

+ Started *string

+ State *string

+ Stream *bool

+ User *string

+ type SwaggerInfo struct

+ Description *string

+ License map[string]interface{}

+ Title *string

+ Version *string

+ type SwaggerResponse struct

+ BasePath *string

+ Info *SwaggerInfo

+ Paths map[string]interface{}

+ Swagger *string

+ type Task interface

+ Command func() *string

+ ID func() *string

+ Name func() *string

+ Offset func() *float64

+ Params func(result interface{}) error

+ Period func() *int64

+ type TaskOptions struct

+ Command *string

+ ID *string

+ Name *string

+ Offset *float64

+ Params interface{}

+ Period *int64

+ type UserDefinedFunctionObject struct

+ Code *string

+ IsDeterministic *bool

+ Name *string

v2.1.4

Jun 27, 2025

Changes in this version

+ const QueryCollection

+ const QueryComplete

+ const QueryFromPrefix

+ const QueryOnDuplicate

+ const QueryToPrefix

+ const QueryType

+ type ClientFoxx interface

+ type ClientFoxxService interface

+ InstallFoxxService func(ctx context.Context, dbName string, zipFile string, options *FoxxCreateOptions) error

+ UninstallFoxxService func(ctx context.Context, dbName string, options *FoxxDeleteOptions) error

type Collection

+ SetPropertiesV2 func(ctx context.Context, options SetCollectionPropertiesOptionsV2) error

+ type CollectionDocumentImport interface

+ ImportDocuments func(ctx context.Context, documents string, ...) (CollectionDocumentImportResponse, error)

+ ImportDocumentsWithOptions func(ctx context.Context, documents string, ...) (CollectionDocumentImportResponse, error)

+ type CollectionDocumentImportDocumentType string

+ const ImportDocumentTypeArray

+ const ImportDocumentTypeAuto

+ const ImportDocumentTypeDocuments

+ const ImportDocumentTypeTabular

+ type CollectionDocumentImportOnDuplicate string

+ const ImportOnDuplicateError

+ const ImportOnDuplicateIgnore

+ const ImportOnDuplicateReplace

+ const ImportOnDuplicateUpdate

+ type CollectionDocumentImportOptions struct

+ Complete *bool

+ FromPrefix *string

+ OnDuplicate *CollectionDocumentImportOnDuplicate

+ Overwrite *bool

+ ToPrefix *string

+ WithWaitForSync *bool

+ type CollectionDocumentImportRequest struct

+ Collection *string

+ Type *CollectionDocumentImportDocumentType

+ type CollectionDocumentImportResponse struct

+ type CollectionDocumentImportStatistics struct

+ Created int64

+ Details []string

+ Empty int64

+ Errors int64

+ Ignored int64

+ Updated int64

+ type CreateCollectionPropertiesV2 struct

+ CacheEnabled *bool

+ ComputedValues *[]ComputedValue

+ DistributeShardsLike *string

+ DoCompact *bool

+ IndexBuckets *int

+ InternalValidatorType *int

+ IsDisjoint *bool

+ IsSmart *bool

+ IsSystem *bool

+ IsVolatile *bool

+ JournalSize *int64

+ KeyOptions *CollectionKeyOptions

+ MinReplicationFactor *int

+ NumberOfShards *int

+ ReplicationFactor *ReplicationFactor

+ Schema *CollectionSchemaOptions

+ ShardKeys *[]string

+ ShardingStrategy *ShardingStrategy

+ SmartGraphAttribute *string

+ SmartJoinAttribute *string

+ SyncByRevision *bool

+ Type *CollectionType

+ WaitForSync *bool

+ WriteConcern *int

+ func (c *CreateCollectionPropertiesV2) Init()

type CursorBatch

+ ReadNextRawBatch func(ctx context.Context, result *connection.RawObject) error

+ RetryReadRawBatch func(ctx context.Context, result *connection.RawObject) error

type DatabaseCollection

+ CreateCollectionV2 func(ctx context.Context, name string, props *CreateCollectionPropertiesV2) (Collection, error)

+ CreateCollectionWithOptionsV2 func(ctx context.Context, name string, props *CreateCollectionPropertiesV2, ...) (Collection, error)

+ type FoxxCreateOptions struct

+ Mount *string

+ type FoxxDeleteOptions struct

+ Mount *string

+ Teardown *bool

+ type InstallFoxxServiceRequest struct

+ type SetCollectionPropertiesOptionsV2 struct

+ CacheEnabled *bool

+ ComputedValues *[]ComputedValue

+ JournalSize *int64

+ MinReplicationFactor *int

+ ReplicationFactor *ReplicationFactor

+ Schema *CollectionSchemaOptions

+ WaitForSync *bool

+ WriteConcern *int

+ type UninstallFoxxServiceRequest struct

v2.1.3

Feb 24, 2025

Changes in this version

type DatabaseAnalyzer

+ EnsureCreatedAnalyzer func(ctx context.Context, analyzer *AnalyzerDefinition) (Analyzer, bool, error)

+ type DocumentMetaWithOldRev struct

+ OldRev string

+ type GraphCollection interface

+ Count func(ctx context.Context) (int64, error)

+ Database func() Database

+ Name func() string

+ type Unmarshal struct

+ Current *C

+ Object T

+ func (u *Unmarshal[C, T]) UnmarshalJSON(bytes []byte) error

+ type UnmarshalData []byte

+ func (u *UnmarshalData) Extract(key string) Unmarshaler

+ func (u *UnmarshalData) Inject(object any) error

+ func (u *UnmarshalData) UnmarshalJSON(bytes []byte) error

+ type Unmarshaler interface

+ Extract func(key string) Unmarshaler

+ Inject func(object any) error

v2.1.2

Nov 15, 2024

Changes in this version

type CollectionDocumentCreateOptions

+ TransactionID string

type CollectionDocumentDeleteOptions

+ TransactionID string

type CollectionDocumentReplaceOptions

+ TransactionID string

type CollectionDocumentUpdateOptions

+ TransactionID string

type QuerySubOptions

+ AllowDirtyReads bool

+ FailOnWarning *bool

+ ForceOneShardAttributeValue *string

+ IntermediateCommitCount *int

+ IntermediateCommitSize *int

+ MaxDNFConditionMembers *int

+ MaxNodesPerCallstack *int

+ MaxNumberOfPlans *int

+ MaxTransactionSize *int

+ MaxWarningCount *int

+ SkipInaccessibleCollections *bool

+ SpillOverThresholdMemoryUsage *int

+ SpillOverThresholdNumRows *int

v2.1.1

Sep 27, 2024

Changes in this version

+ const HeaderDirtyReads

+ const HeaderIfMatch

+ const HeaderIfNoneMatch

+ const HeaderTransaction

+ const QueryDirection

+ const QueryIgnoreRevs

+ const QueryIsRestore

+ const QueryKeepNull

+ const QueryMergeObjects

+ const QueryOverwrite

+ const QueryOverwriteMode

+ const QueryRefillIndexCaches

+ const QueryReturnNew

+ const QueryReturnOld

+ const QueryRev

+ const QuerySilent

+ const QueryVersionAttribute

+ const QueryWaitForSync

type BeginTransactionOptions

+ AllowDirtyReads *bool

+ SkipFastLockRound bool

type ClientAdmin

+ CheckAvailability func(ctx context.Context, serverEndpoint string) error

type DatabaseGraph

+ GetEdges func(ctx context.Context, name, vertex string, options *GetEdgesOptions) ([]EdgeDetails, error)

+ type EdgeDetails struct

+ From string

+ Label string

+ To string

+ type EdgeDirection string

+ const EdgeDirectionIn

+ const EdgeDirectionOut

+ type GetEdgesOptions struct

+ AllowDirtyReads *bool

+ Direction EdgeDirection

type QueryOptions

+ AllowDirtyReads *bool

+ TransactionID string

v2.1.0

Apr 2, 2024

Changes in this version

+ const MDIIndexType

+ const MDIPrefixedIndexType

+ const SatelliteGraph

+ type ArangoSearchAliasOperation string

+ const ArangoSearchAliasOperationAdd

+ const ArangoSearchAliasOperationDel

+ type ArangoSearchAliasUpdateOpts struct

+ Indexes []ArangoSearchAliasIndex

+ Operation ArangoSearchAliasOperation

type ArangoSearchAnalyzerProperties

+ Delimiters []string

+ NGramSize uint

type ArangoSearchAnalyzerType

+ const ArangoSearchAnalyzerTypeMultiDelimiter

+ const ArangoSearchAnalyzerTypeWildcard

type ArangoSearchView

+ UpdateProperties func(ctx context.Context, options ArangoSearchViewProperties) error

type ArangoSearchViewAlias

+ UpdateProperties func(ctx context.Context, options ArangoSearchAliasUpdateOpts) error

type ArangoSearchViewProperties

+ WriteBufferIdle *int64

+ type BackupCreateOptions struct

+ AllowInconsistent *bool

+ Force *bool

+ Label string

+ Timeout *uint

+ type BackupListOptions struct

+ ID string

+ type BackupMeta struct

+ Available bool

+ Keys []BackupMetaSha256

+ NumberOfPiecesPresent uint

+ Version string

+ type BackupMetaSha256 struct

+ SHA256 string

+ type BackupResponse struct

+ CreationTime time.Time

+ ID string

+ NumberOfDBServers uint

+ NumberOfFiles uint

+ PotentiallyInconsistent bool

+ SizeInBytes uint64

+ type BackupRestoreResponse struct

+ Previous string

+ type BackupTransferProgressResponse struct

+ BackupID string

+ Cancelled bool

+ DBServers map[string]BackupTransferReport

+ Timestamp string

+ type BackupTransferReport struct

+ Error int

+ ErrorMessage string

+ Progress struct{ ... }

+ Status BackupTransferStatus

+ type BackupTransferStatus string

+ const TransferAcknowledged

+ const TransferCancelled

+ const TransferCompleted

+ const TransferFailed

+ const TransferStarted

type ClientAdminBackup

+ BackupCreate func(ctx context.Context, opt *BackupCreateOptions) (BackupResponse, error)

+ BackupDelete func(ctx context.Context, id string) error

+ BackupDownload func(ctx context.Context, backupId string, remoteRepository string, ...) (TransferMonitor, error)

+ BackupList func(ctx context.Context, opt *BackupListOptions) (ListBackupsResponse, error)

+ BackupRestore func(ctx context.Context, id string) (BackupRestoreResponse, error)

+ BackupUpload func(ctx context.Context, backupId string, remoteRepository string, ...) (TransferMonitor, error)

+ TransferMonitor func(jobId string, transferType TransferType) (TransferMonitor, error)

+ type ClientAdminCluster interface

+ CleanOutServer func(ctx context.Context, serverID ServerID) (string, error)

+ DatabaseInventory func(ctx context.Context, dbName string) (DatabaseInventory, error)

+ Health func(ctx context.Context) (ClusterHealth, error)

+ IsCleanedOut func(ctx context.Context, serverID ServerID) (bool, error)

+ MoveShard func(ctx context.Context, col Collection, shard ShardID, ...) (string, error)

+ NumberOfServers func(ctx context.Context) (NumberOfServersResponse, error)

+ RemoveServer func(ctx context.Context, serverID ServerID) error

+ ResignServer func(ctx context.Context, serverID ServerID) (string, error)

type ClientAdminLicense

+ SetLicense func(ctx context.Context, license string, force bool) error

type ClientDatabase

+ GetDatabase func(ctx context.Context, name string, options *GetDatabaseOptions) (Database, error)

+ type ClientUsers interface

+ CreateUser func(ctx context.Context, name string, options *UserOptions) (User, error)

+ RemoveUser func(ctx context.Context, name string) error

+ ReplaceUser func(ctx context.Context, name string, options *UserOptions) (User, error)

+ UpdateUser func(ctx context.Context, name string, options *UserOptions) (User, error)

+ User func(ctx context.Context, name string) (User, error)

+ UserExists func(ctx context.Context, name string) (bool, error)

+ Users func(ctx context.Context) ([]User, error)

type CollectionDocumentCreateOptions

+ VersionAttribute string

type CollectionDocumentReplaceOptions

+ VersionAttribute string

type CollectionDocumentUpdateOptions

+ VersionAttribute string

type CollectionIndexes

+ EnsureMDIIndex func(ctx context.Context, fields []string, options *CreateMDIIndexOptions) (IndexResponse, bool, error)

+ EnsureMDIPrefixedIndex func(ctx context.Context, fields []string, options *CreateMDIPrefixedIndexOptions) (IndexResponse, bool, error)

+ type CreateEdgeDefinitionOptions struct

+ Satellites []string

+ type CreateEdgeDefinitionResponse struct

+ GraphDefinition *GraphDefinition

+ type CreateEdgeOptions struct

+ NewObject interface{}

+ TransactionID string

+ WaitForSync *bool

type CreateGeoIndexOptions

+ InBackground *bool

+ type CreateGraphOptions struct

+ Satellites []string

+ type CreateMDIIndexOptions struct

+ FieldValueTypes MDIFieldType

+ InBackground *bool

+ Name string

+ Sparse *bool

+ StoredValues []string

+ Unique *bool

+ type CreateMDIPrefixedIndexOptions struct

+ PrefixFields []string

type CreatePersistentIndexOptions

+ InBackground *bool

type CreateTTLIndexOptions

+ InBackground *bool

+ type CreateVertexCollectionOptions struct

+ Satellites []string

+ type CreateVertexCollectionResponse struct

+ GraphDefinition *GraphDefinition

+ type CreateVertexOptions struct

+ NewObject interface{}

+ TransactionID string

+ WaitForSync *bool

type DatabaseCollection

+ GetCollection func(ctx context.Context, name string, options *GetCollectionOptions) (Collection, error)

+ type DatabaseGraph interface

+ CreateGraph func(ctx context.Context, name string, graph *GraphDefinition, ...) (Graph, error)

+ Graph func(ctx context.Context, name string, options *GetGraphOptions) (Graph, error)

+ GraphExists func(ctx context.Context, name string) (bool, error)

+ Graphs func(ctx context.Context) (GraphsResponseReader, error)

+ type DatabaseInventory struct

+ Collections []InventoryCollection

+ Info DatabaseInfo

+ State ServerStatus

+ Tick string

+ Views []InventoryView

+ func (i DatabaseInventory) CollectionByName(name string) (InventoryCollection, bool)

+ func (i DatabaseInventory) ViewByName(name string) (InventoryView, bool)

+ type DatabasePermissions struct

+ Collections map[string]Grant

+ Permission Grant

type DatabaseView

+ ViewsAll func(ctx context.Context) ([]View, error)

+ type DeleteEdgeDefinitionOptions struct

+ DropCollection *bool

+ WaitForSync *bool

+ type DeleteEdgeDefinitionResponse struct

+ GraphDefinition *GraphDefinition

+ type DeleteEdgeOptions struct

+ IfMatch string

+ OldObject interface{}

+ TransactionID string

+ WaitForSync *bool

+ type DeleteVertexCollectionOptions struct

+ DropCollection *bool

+ type DeleteVertexCollectionResponse struct

+ GraphDefinition *GraphDefinition

+ type DeleteVertexOptions struct

+ IfMatch string

+ OldObject interface{}

+ TransactionID string

+ WaitForSync *bool

+ type Edge interface

+ CreateEdge func(ctx context.Context, Edge interface{}, opts *CreateEdgeOptions) (EdgeCreateResponse, error)

+ DeleteEdge func(ctx context.Context, key string, opts *DeleteEdgeOptions) (EdgeDeleteResponse, error)

+ GetEdge func(ctx context.Context, key string, result interface{}, opts *GetEdgeOptions) error

+ Name func() string

+ ReplaceEdge func(ctx context.Context, key string, newValue interface{}, ...) (EdgeReplaceResponse, error)

+ UpdateEdge func(ctx context.Context, key string, newValue interface{}, opts *EdgeUpdateOptions) (EdgeUpdateResponse, error)

+ type EdgeCreateResponse struct

+ New interface{}

+ type EdgeDefinition struct

+ Collection string

+ From []string

+ To []string

+ type EdgeDeleteResponse struct

+ Old interface{}

+ type EdgeReplaceOptions struct

+ IfMatch string

+ KeepNull *bool

+ NewObject interface{}

+ OldObject interface{}

+ TransactionID string

+ WaitForSync *bool

+ type EdgeReplaceResponse struct

+ New interface{}

+ Old interface{}

+ type EdgeUpdateOptions struct

+ IfMatch string

+ KeepNull *bool

+ NewObject interface{}

+ OldObject interface{}

+ TransactionID string

+ WaitForSync *bool

+ type EdgeUpdateResponse struct

+ New interface{}

+ Old interface{}

+ type GetCollectionOptions struct

+ SkipExistCheck bool

+ type GetDatabaseOptions struct

+ SkipExistCheck bool

+ type GetEdgeOptions struct

+ IfMatch string

+ IfNoneMatch string

+ Rev string

+ TransactionID string

+ type GetGraphOptions struct

+ SkipExistCheck bool

+ type GetVertexOptions struct

+ IfMatch string

+ IfNoneMatch string

+ Rev string

+ TransactionID string

+ type Grant string

+ const GrantNone

+ const GrantReadOnly

+ const GrantReadWrite

+ const GrantUndefined

+ type Graph interface

+ EdgeDefinitions func() []EdgeDefinition

+ IsDisjoint func() bool

+ IsSatellite func() bool

+ IsSmart func() bool

+ Name func() string

+ NumberOfShards func() *int

+ OrphanCollections func() []string

+ Remove func(ctx context.Context, opts *RemoveGraphOptions) error

+ ReplicationFactor func() int

+ SmartGraphAttribute func() string

+ WriteConcern func() *int

+ type GraphDefinition struct

+ EdgeDefinitions []EdgeDefinition

+ IsDisjoint bool

+ IsSatellite bool

+ IsSmart bool

+ Name string

+ NumberOfShards *int

+ OrphanCollections []string

+ ReplicationFactor graphReplicationFactor

+ SmartGraphAttribute string

+ WriteConcern *int

+ type GraphEdgesDefinition interface

+ CreateEdgeDefinition func(ctx context.Context, collection string, from, to []string, ...) (CreateEdgeDefinitionResponse, error)

+ DeleteEdgeDefinition func(ctx context.Context, collection string, opts *DeleteEdgeDefinitionOptions) (DeleteEdgeDefinitionResponse, error)

+ EdgeDefinition func(ctx context.Context, collection string) (Edge, error)

+ EdgeDefinitionExists func(ctx context.Context, collection string) (bool, error)

+ GetEdgeDefinitions func(ctx context.Context) ([]Edge, error)

+ ReplaceEdgeDefinition func(ctx context.Context, collection string, from, to []string, ...) (ReplaceEdgeDefinitionResponse, error)

+ type GraphVertexCollections interface

+ CreateVertexCollection func(ctx context.Context, name string, opts *CreateVertexCollectionOptions) (CreateVertexCollectionResponse, error)

+ DeleteVertexCollection func(ctx context.Context, name string, opts *DeleteVertexCollectionOptions) (DeleteVertexCollectionResponse, error)

+ VertexCollection func(ctx context.Context, name string) (VertexCollection, error)

+ VertexCollectionExists func(ctx context.Context, name string) (bool, error)

+ VertexCollections func(ctx context.Context) ([]VertexCollection, error)

+ type GraphsResponseReader interface

+ Read func() (Graph, error)

+ type InventoryCollection struct

+ AllInSync bool

+ Indexes []InventoryIndex

+ IsReady bool

+ Parameters InventoryCollectionParameters

+ PlanVersion int64

+ type InventoryCollectionParameters struct

+ Deleted bool

+ PlanID string

+ Shards map[ShardID][]ServerID

+ type InventoryIndex struct

+ CacheEnabled *bool

+ Deduplicate bool

+ Estimates bool

+ ExpireAfter int

+ FieldValueTypes string

+ Fields []string

+ GeoJSON bool

+ ID string

+ MinLength int

+ Name string

+ Sparse bool

+ Type string

+ Unique bool

+ type InventoryView struct

+ Deleted bool

+ ID string

+ IsSystem bool

+ Name string

+ PlanID string

+ Type ViewType

type InvertedIndexOptions

+ InBackground *bool

type License

+ Hash string

+ type ListBackupsResponse struct

+ Backups map[string]BackupMeta

+ Server string

+ type MDIFieldType string

+ const MDIDoubleFieldType

+ type NumberOfServersResponse struct

+ CleanedServerIDs []ServerID

+ NoCoordinators int

+ NoDBServers int

+ type RemoveGraphOptions struct

+ DropCollections bool

+ type ReplaceEdgeDefinitionResponse struct

+ GraphDefinition *GraphDefinition

+ type ReplaceEdgeOptions struct

+ DropCollection *bool

+ Satellites []string

+ WaitForSync *bool

+ type TransferMonitor interface

+ Abort func(ctx context.Context) error

+ Progress func(ctx context.Context) (BackupTransferProgressResponse, error)

+ type TransferType string

+ const TransferTypeDownload

+ const TransferTypeUpload

+ type User interface

+ Extra func(result interface{}) error

+ IsActive func() bool

+ Name func() string

+ type UserOptions struct

+ Active *bool

+ Extra interface{}

+ Password string

+ type UserPermissions interface

+ AccessibleDatabases func(ctx context.Context) (map[string]Grant, error)

+ AccessibleDatabasesFull func(ctx context.Context) (map[string]DatabasePermissions, error)

+ GetCollectionAccess func(ctx context.Context, db, col string) (Grant, error)

+ GetDatabaseAccess func(ctx context.Context, db string) (Grant, error)

+ RemoveCollectionAccess func(ctx context.Context, db, col string) error

+ RemoveDatabaseAccess func(ctx context.Context, db string) error

+ SetCollectionAccess func(ctx context.Context, db, col string, access Grant) error

+ SetDatabaseAccess func(ctx context.Context, db string, access Grant) error

+ type VertexCollection interface

+ CreateVertex func(ctx context.Context, vertex interface{}, opts *CreateVertexOptions) (VertexCreateResponse, error)

+ DeleteVertex func(ctx context.Context, key string, opts *DeleteVertexOptions) (VertexDeleteResponse, error)

+ GetVertex func(ctx context.Context, key string, result interface{}, opts *GetVertexOptions) error

+ Name func() string

+ ReplaceVertex func(ctx context.Context, key string, newValue interface{}, ...) (VertexReplaceResponse, error)

+ UpdateVertex func(ctx context.Context, key string, newValue interface{}, ...) (VertexUpdateResponse, error)

+ type VertexCreateResponse struct

+ New interface{}

+ type VertexDeleteResponse struct

+ Old interface{}

+ type VertexReplaceOptions struct

+ IfMatch string

+ KeepNull *bool

+ NewObject interface{}

+ OldObject interface{}

+ TransactionID string

+ WaitForSync *bool

+ type VertexReplaceResponse struct

+ New interface{}

+ Old interface{}

+ type VertexUpdateOptions struct

+ IfMatch string

+ KeepNull *bool

+ NewObject interface{}

+ OldObject interface{}

+ TransactionID string

+ WaitForSync *bool

+ type VertexUpdateResponse struct

+ New interface{}

+ Old interface{}

v2.0.3

Oct 31, 2023

Changes in this version

+ const ViewTypeArangoSearch

+ const ViewTypeSearchAlias

+ type Analyzer interface

+ Database func() Database

+ Definition func() AnalyzerDefinition

+ Name func() string

+ Remove func(ctx context.Context, force bool) error

+ Type func() ArangoSearchAnalyzerType

+ UniqueName func() string

+ type AnalyzerDefinition struct

+ Features []ArangoSearchFeature

+ Name string

+ Properties ArangoSearchAnalyzerProperties

+ Type ArangoSearchAnalyzerType

+ type AnalyzersResponseReader interface

+ Read func() (Analyzer, error)

+ type ArangoSearchAliasIndex struct

+ Collection string

+ Index string

+ type ArangoSearchAliasViewProperties struct

+ Indexes []ArangoSearchAliasIndex

+ type ArangoSearchAnalyzerAQLReturnType string

+ const ArangoSearchAnalyzerAQLReturnTypeBool

+ const ArangoSearchAnalyzerAQLReturnTypeNumber

+ const ArangoSearchAnalyzerAQLReturnTypeString

+ func (a ArangoSearchAnalyzerAQLReturnType) New() *ArangoSearchAnalyzerAQLReturnType

+ type ArangoSearchAnalyzerGeoJSONType string

+ const ArangoSearchAnalyzerGeoJSONTypeCentroid

+ const ArangoSearchAnalyzerGeoJSONTypePoint

+ const ArangoSearchAnalyzerGeoJSONTypeShape

+ func (a ArangoSearchAnalyzerGeoJSONType) New() *ArangoSearchAnalyzerGeoJSONType

+ type ArangoSearchAnalyzerGeoOptions struct

+ MaxCells *int

+ MaxLevel *int

+ MinLevel *int

+ type ArangoSearchAnalyzerPipeline struct

+ Properties ArangoSearchAnalyzerProperties

+ Type ArangoSearchAnalyzerType

+ type ArangoSearchAnalyzerProperties struct

+ Accent *bool

+ Analyzer *AnalyzerDefinition

+ BatchSize *int

+ Break ArangoSearchBreakType

+ Case ArangoSearchCaseType

+ CollapsePositions *bool

+ Delimiter string

+ EdgeNGram *ArangoSearchEdgeNGram

+ EndMarker *string

+ Format *ArangoSearchFormat

+ Hex *bool

+ IsSystem bool

+ KeepNull *bool

+ Latitude []string

+ Locale string

+ Longitude []string

+ Max *int64

+ MemoryLimit *int

+ Min *int64

+ ModelLocation string

+ NumHashes *uint64

+ Options *ArangoSearchAnalyzerGeoOptions

+ Pipeline []ArangoSearchAnalyzerPipeline

+ PreserveOriginal *bool

+ QueryString string

+ ReturnType *ArangoSearchAnalyzerAQLReturnType

+ StartMarker *string

+ Stemming *bool

+ Stopwords []string

+ StopwordsPath []string

+ StreamType *ArangoSearchNGramStreamType

+ Threshold *float64

+ TopK *uint64

+ Type *ArangoSearchAnalyzerGeoJSONType

+ type ArangoSearchAnalyzerType string

+ const ArangoSearchAnalyzerTypeAQL

+ const ArangoSearchAnalyzerTypeClassification

+ const ArangoSearchAnalyzerTypeCollation

+ const ArangoSearchAnalyzerTypeDelimiter

+ const ArangoSearchAnalyzerTypeGeoJSON

+ const ArangoSearchAnalyzerTypeGeoPoint

+ const ArangoSearchAnalyzerTypeGeoS2

+ const ArangoSearchAnalyzerTypeIdentity

+ const ArangoSearchAnalyzerTypeMinhash

+ const ArangoSearchAnalyzerTypeNGram

+ const ArangoSearchAnalyzerTypeNearestNeighbors

+ const ArangoSearchAnalyzerTypeNorm

+ const ArangoSearchAnalyzerTypePipeline

+ const ArangoSearchAnalyzerTypeSegmentation

+ const ArangoSearchAnalyzerTypeStem

+ const ArangoSearchAnalyzerTypeStopwords

+ const ArangoSearchAnalyzerTypeText

+ type ArangoSearchBreakType string

+ const ArangoSearchBreakTypeAll

+ const ArangoSearchBreakTypeAlpha

+ const ArangoSearchBreakTypeGraphic

+ type ArangoSearchCaseType string

+ const ArangoSearchCaseLower

+ const ArangoSearchCaseNone

+ const ArangoSearchCaseUpper

+ type ArangoSearchConsolidationPolicy struct

+ Type ArangoSearchConsolidationPolicyType

+ type ArangoSearchConsolidationPolicyBytesAccum struct

+ Threshold *float64

+ type ArangoSearchConsolidationPolicyTier struct

+ Lookahead *int64

+ MaxSegments *int64

+ MinScore *int64

+ MinSegments *int64

+ SegmentsBytesFloor *int64

+ SegmentsBytesMax *int64

+ type ArangoSearchConsolidationPolicyType string

+ const ArangoSearchConsolidationPolicyTypeBytesAccum

+ const ArangoSearchConsolidationPolicyTypeTier

+ type ArangoSearchEdgeNGram struct

+ Max *int64

+ Min *int64

+ PreserveOriginal *bool

+ type ArangoSearchElementProperties struct

+ AnalyzerDefinitions []AnalyzerDefinition

+ Analyzers []string

+ Cache *bool

+ Fields ArangoSearchFields

+ InBackground *bool

+ IncludeAllFields *bool

+ Nested ArangoSearchFields

+ StoreValues ArangoSearchStoreValues

+ TrackListPositions *bool

+ type ArangoSearchFeature string

+ const ArangoSearchFeatureFrequency

+ const ArangoSearchFeatureNorm

+ const ArangoSearchFeatureOffset

+ const ArangoSearchFeaturePosition

+ type ArangoSearchFields map[string]ArangoSearchElementProperties

+ type ArangoSearchFormat string

+ const ArangoSearchFormatLatLngDouble

+ const ArangoSearchFormatLatLngInt

+ const ArangoSearchFormatS2Point

+ type ArangoSearchLinks map[string]ArangoSearchElementProperties

+ type ArangoSearchNGramStreamType string

+ const ArangoSearchNGramStreamBinary

+ const ArangoSearchNGramStreamUTF8

+ type ArangoSearchPrimarySortEntry struct

+ Ascending *bool

+ Field string

+ func (pse ArangoSearchPrimarySortEntry) GetAscending() bool

+ type ArangoSearchStoreValues string

+ const ArangoSearchStoreValuesID

+ const ArangoSearchStoreValuesNone

+ type ArangoSearchView interface

+ Properties func(ctx context.Context) (ArangoSearchViewProperties, error)

+ SetProperties func(ctx context.Context, options ArangoSearchViewProperties) error

+ type ArangoSearchViewAlias interface

+ Properties func(ctx context.Context) (ArangoSearchAliasViewProperties, error)

+ SetProperties func(ctx context.Context, options ArangoSearchAliasViewProperties) error

+ type ArangoSearchViewProperties struct

+ CleanupIntervalStep *int64

+ CommitInterval *int64

+ ConsolidationInterval *int64

+ ConsolidationPolicy *ArangoSearchConsolidationPolicy

+ Links ArangoSearchLinks

+ OptimizeTopK []string

+ PrimaryKeyCache *bool

+ PrimarySort []ArangoSearchPrimarySortEntry

+ PrimarySortCache *bool

+ PrimarySortCompression PrimarySortCompression

+ StoredValues []StoredValue

+ WriteBufferActive *int64

+ WriteBufferIdel *int64

+ WriteBufferSizeMax *int64

+ type AsyncJobDeleteOptions struct

+ JobID string

+ Stamp time.Time

+ type AsyncJobDeleteType string

+ const DeleteAllJobs

+ const DeleteExpiredJobs

+ const DeleteSingleJob

+ type AsyncJobListOptions struct

+ Count int

+ type AsyncJobStatusType string

+ const JobDone

+ const JobPending

type ClientAdmin

+ ServerMode func(ctx context.Context) (ServerMode, error)

+ SetServerMode func(ctx context.Context, mode ServerMode) error

+ type ClientAdminLicense interface

+ GetLicense func(ctx context.Context) (License, error)

+ type ClientAsyncJob interface

+ AsyncJobCancel func(ctx context.Context, jobID string) (bool, error)

+ AsyncJobDelete func(ctx context.Context, deleteType AsyncJobDeleteType, ...) (bool, error)

+ AsyncJobList func(ctx context.Context, jobType AsyncJobStatusType, opts *AsyncJobListOptions) ([]string, error)

+ AsyncJobStatus func(ctx context.Context, jobID string) (AsyncJobStatusType, error)

type ClientServerInfo

+ ServerID func(ctx context.Context) (string, error)

+ VersionWithOptions func(ctx context.Context, opts *GetVersionOptions) (VersionInfo, error)

type Collection

+ Count func(ctx context.Context) (int64, error)

+ Properties func(ctx context.Context) (CollectionProperties, error)

+ RemoveWithOptions func(ctx context.Context, opts *RemoveCollectionOptions) error

+ SetProperties func(ctx context.Context, options SetCollectionPropertiesOptions) error

+ Truncate func(ctx context.Context) error

type CollectionDocumentCreateOptions

+ IgnoreRevs *bool

+ IsRestore *bool

+ KeepNull *bool

+ MergeObjects *bool

type CollectionDocumentDeleteOptions

+ IfMatch string

+ IgnoreRevs *bool

+ OldObject interface{}

type CollectionDocumentReadOptions

+ AllowDirtyReads *bool

+ IfMatch string

+ IfNoneMatch string

+ IgnoreRevs *bool

+ TransactionID string

+ type CollectionDocumentReplace interface

+ ReplaceDocument func(ctx context.Context, key string, document interface{}) (CollectionDocumentReplaceResponse, error)

+ ReplaceDocumentWithOptions func(ctx context.Context, key string, document interface{}, ...) (CollectionDocumentReplaceResponse, error)

+ ReplaceDocuments func(ctx context.Context, documents interface{}) (CollectionDocumentReplaceResponseReader, error)

+ ReplaceDocumentsWithOptions func(ctx context.Context, documents interface{}, ...) (CollectionDocumentReplaceResponseReader, error)

+ type CollectionDocumentReplaceOptions struct

+ IfMatch string

+ IgnoreRevs *bool

+ IsRestore *bool

+ NewObject interface{}

+ OldObject interface{}

+ RefillIndexCaches *bool

+ Silent *bool

+ WithWaitForSync *bool

+ type CollectionDocumentReplaceResponse struct

+ New interface{}

+ Old interface{}

+ type CollectionDocumentReplaceResponseReader interface

+ Read func() (CollectionDocumentReplaceResponse, error)

type CollectionDocumentUpdateOptions

+ IfMatch string

+ IgnoreRevs *bool

+ KeepNull *bool

+ MergeObjects *bool

+ Silent *bool

type CollectionExtendedInfo

+ ComputedValues []ComputedValue

+ InternalValidatorType int

+ IsDisjoint bool

+ IsSmart bool

+ IsSmartChild bool

type CollectionInfo

+ StatusString string

type CollectionProperties

+ IndexBuckets int

+ IsVolatile bool

+ SmartGraphAttribute string

+ type ComputeOn string

+ const ComputeOnInsert

+ const ComputeOnReplace

+ const ComputeOnUpdate

+ type ComputedValue struct

+ ComputeOn []ComputeOn

+ Expression string

+ FailOnWarning *bool

+ KeepNull *bool

+ Name string

+ Overwrite bool

type CreateCollectionOptions

+ EnforceReplicationFactor *bool

+ type CreateCollectionProperties struct

+ CacheEnabled *bool

+ ComputedValues []ComputedValue

+ DistributeShardsLike string

+ DoCompact *bool

+ IndexBuckets int

+ InternalValidatorType int

+ IsDisjoint bool

+ IsSmart bool

+ IsSystem bool

+ IsVolatile bool

+ JournalSize int64

+ KeyOptions *CollectionKeyOptions

+ MinReplicationFactor int

+ NumberOfShards int

+ ReplicationFactor ReplicationFactor

+ Schema *CollectionSchemaOptions

+ ShardKeys []string

+ ShardingStrategy ShardingStrategy

+ SmartGraphAttribute string

+ SmartJoinAttribute string

+ SyncByRevision bool

+ Type CollectionType

+ WaitForSync bool

+ WriteConcern int

+ func (c *CreateCollectionProperties) Init()

type Database

+ TransactionJS func(ctx context.Context, options TransactionJSOptions) (interface{}, error)

+ type DatabaseAnalyzer interface

+ Analyzer func(ctx context.Context, name string) (Analyzer, error)

+ Analyzers func(ctx context.Context) (AnalyzersResponseReader, error)

+ EnsureAnalyzer func(ctx context.Context, analyzer *AnalyzerDefinition) (bool, Analyzer, error)

type DatabaseCollection

+ CreateCollectionWithOptions func(ctx context.Context, name string, props *CreateCollectionProperties, ...) (Collection, error)

+ type DatabaseView interface

+ CreateArangoSearchAliasView func(ctx context.Context, name string, options *ArangoSearchAliasViewProperties) (ArangoSearchViewAlias, error)

+ CreateArangoSearchView func(ctx context.Context, name string, options *ArangoSearchViewProperties) (ArangoSearchView, error)

+ View func(ctx context.Context, name string) (View, error)

+ ViewExists func(ctx context.Context, name string) (bool, error)

+ Views func(ctx context.Context) (ViewsResponseReader, error)

+ type GetVersionOptions struct

+ Details *bool

+ type License struct

+ Features LicenseFeatures

+ License string

+ Status LicenseStatus

+ Version int

+ type LicenseFeatures struct

+ Expires int

+ type LicenseStatus string

+ const LicenseStatusExpired

+ const LicenseStatusExpiring

+ const LicenseStatusGood

+ const LicenseStatusReadOnly

+ type RemoveCollectionOptions struct

+ IsSystem *bool

+ type RemoveViewOptions struct

+ IsSystem *bool

+ type ServerMode string

+ const ServerModeDefault

+ const ServerModeReadOnly

type SetCollectionPropertiesOptions

+ ComputedValues []ComputedValue

+ type TransactionJSOptions struct

+ Action string

+ AllowImplicit *bool

+ Collections TransactionCollections

+ LockTimeout *int

+ MaxTransactionSize *int

+ Params []string

+ WaitForSync *bool

+ type View interface

+ ArangoSearchView func() (ArangoSearchView, error)

+ ArangoSearchViewAlias func() (ArangoSearchViewAlias, error)

+ Database func() Database

+ Name func() string

+ Remove func(ctx context.Context) error

+ RemoveWithOptions func(ctx context.Context, opts *RemoveViewOptions) error

+ Rename func(ctx context.Context, newName string) error

+ Type func() ViewType

+ type ViewBase struct

+ GloballyUniqueId string

+ ID string

+ Name string

+ Type ViewType

+ type ViewType string

+ type ViewsResponseReader interface

+ Read func() (View, error)

v2.0.2

May 30, 2023

v2.0.1

May 30, 2023

Changes in this version

+ const CollectionStatusDeleted

+ const CollectionStatusLoaded

+ const CollectionStatusLoading

+ const CollectionStatusNewBorn

+ const CollectionStatusUnloaded

+ const CollectionStatusUnloading

+ const CollectionTypeDocument

+ const CollectionTypeEdge

+ const EdgeIndexType

+ const EngineTypeMMFiles

+ const EngineTypeRocksDB

+ const FullTextIndex

+ const GeoIndexType

+ const HashIndex

+ const InvertedIndexType

+ const KeyGeneratorAutoIncrement

+ const KeyGeneratorTraditional

+ const PersistentIndexType

+ const PrimaryIndexType

+ const SkipListIndex

+ const TTLIndexType

+ const ZKDIndexType

+ func CreateDocuments(ctx context.Context, col Collection, docCount int, generator func(i int) any) error

+ type AbortTransactionOptions struct

+ type AnalyzerFeature string

+ const AnalyzerFeatureFrequency

+ const AnalyzerFeatureNorm

+ const AnalyzerFeatureOffset

+ const AnalyzerFeaturePosition

+ type BeginTransactionOptions struct

+ AllowImplicit bool

+ LockTimeout float64

+ LockTimeoutDuration time.Duration

+ MaxTransactionSize uint64

+ WaitForSync bool

+ type Client interface

+ Connection func() connection.Connection

+ func NewClient(connection connection.Connection) Client

+ type ClientAdmin interface

+ Health func(ctx context.Context) (ClusterHealth, error)

+ type ClientAdminBackup interface

+ type ClientAdminLog interface

+ GetLogLevels func(ctx context.Context, opts *LogLevelsGetOptions) (LogLevels, error)

+ SetLogLevels func(ctx context.Context, logLevels LogLevels, opts *LogLevelsSetOptions) error

+ type ClientDatabase interface

+ AccessibleDatabases func(ctx context.Context) ([]Database, error)

+ CreateDatabase func(ctx context.Context, name string, options *CreateDatabaseOptions) (Database, error)

+ Database func(ctx context.Context, name string) (Database, error)

+ DatabaseExists func(ctx context.Context, name string) (bool, error)

+ Databases func(ctx context.Context) ([]Database, error)

+ type ClientServerInfo interface

+ ServerRole func(ctx context.Context) (ServerRole, error)

+ Version func(ctx context.Context) (VersionInfo, error)

+ type ClusterHealth struct

+ Health map[ServerID]ServerHealth

+ ID string

+ type Collection interface

+ Database func() Database

+ Name func() string

+ Remove func(ctx context.Context) error

+ Shards func(ctx context.Context, details bool) (CollectionShards, error)

+ type CollectionDocumentCreate interface

+ CreateDocument func(ctx context.Context, document interface{}) (CollectionDocumentCreateResponse, error)

+ CreateDocumentWithOptions func(ctx context.Context, document interface{}, ...) (CollectionDocumentCreateResponse, error)

+ CreateDocuments func(ctx context.Context, documents interface{}) (CollectionDocumentCreateResponseReader, error)

+ CreateDocumentsWithOptions func(ctx context.Context, documents interface{}, ...) (CollectionDocumentCreateResponseReader, error)

+ type CollectionDocumentCreateOptions struct

+ NewObject interface{}

+ OldObject interface{}

+ Overwrite *bool

+ OverwriteMode *CollectionDocumentCreateOverwriteMode

+ RefillIndexCaches *bool

+ Silent *bool

+ WithWaitForSync *bool

+ type CollectionDocumentCreateOverwriteMode string

+ const CollectionDocumentCreateOverwriteModeConflict

+ const CollectionDocumentCreateOverwriteModeIgnore

+ const CollectionDocumentCreateOverwriteModeReplace

+ const CollectionDocumentCreateOverwriteModeUpdate

+ func (c *CollectionDocumentCreateOverwriteMode) Get() CollectionDocumentCreateOverwriteMode

+ func (c *CollectionDocumentCreateOverwriteMode) String() string

+ func (c CollectionDocumentCreateOverwriteMode) New() *CollectionDocumentCreateOverwriteMode

+ type CollectionDocumentCreateResponse struct

+ New interface{}

+ Old interface{}

+ type CollectionDocumentCreateResponseReader interface

+ Read func() (CollectionDocumentCreateResponse, error)

+ type CollectionDocumentDelete interface

+ DeleteDocument func(ctx context.Context, key string) (CollectionDocumentDeleteResponse, error)

+ DeleteDocumentWithOptions func(ctx context.Context, key string, opts *CollectionDocumentDeleteOptions) (CollectionDocumentDeleteResponse, error)

+ DeleteDocuments func(ctx context.Context, keys []string) (CollectionDocumentDeleteResponseReader, error)

+ DeleteDocumentsWithOptions func(ctx context.Context, keys []string, opts *CollectionDocumentDeleteOptions) (CollectionDocumentDeleteResponseReader, error)

+ type CollectionDocumentDeleteOptions struct

+ RefillIndexCaches *bool

+ ReturnOld *bool

+ Silent *bool

+ WithWaitForSync *bool

+ type CollectionDocumentDeleteResponse struct

+ Old interface{}

+ type CollectionDocumentDeleteResponseReader interface

+ Read func(i interface{}) (CollectionDocumentDeleteResponse, error)

+ type CollectionDocumentRead interface

+ ReadDocument func(ctx context.Context, key string, result interface{}) (DocumentMeta, error)

+ ReadDocumentWithOptions func(ctx context.Context, key string, result interface{}, ...) (DocumentMeta, error)

+ ReadDocuments func(ctx context.Context, keys []string) (CollectionDocumentReadResponseReader, error)

+ ReadDocumentsWithOptions func(ctx context.Context, keys []string, opts *CollectionDocumentReadOptions) (CollectionDocumentReadResponseReader, error)

+ type CollectionDocumentReadOptions struct

+ type CollectionDocumentReadResponse struct

+ type CollectionDocumentReadResponseReader interface

+ Read func(i interface{}) (CollectionDocumentReadResponse, error)

+ type CollectionDocumentUpdate interface

+ UpdateDocument func(ctx context.Context, key string, document interface{}) (CollectionDocumentUpdateResponse, error)

+ UpdateDocumentWithOptions func(ctx context.Context, key string, document interface{}, ...) (CollectionDocumentUpdateResponse, error)

+ UpdateDocuments func(ctx context.Context, documents interface{}) (CollectionDocumentUpdateResponseReader, error)

+ UpdateDocumentsWithOptions func(ctx context.Context, documents interface{}, ...) (CollectionDocumentUpdateResponseReader, error)

+ type CollectionDocumentUpdateOptions struct

+ NewObject interface{}

+ OldObject interface{}

+ RefillIndexCaches *bool

+ WithWaitForSync *bool

+ type CollectionDocumentUpdateResponse struct

+ New interface{}

+ Old interface{}

+ type CollectionDocumentUpdateResponseReader interface

+ Read func() (CollectionDocumentUpdateResponse, error)

+ type CollectionDocuments interface

+ DocumentExists func(ctx context.Context, key string) (bool, error)

+ type CollectionExtendedInfo struct

+ CacheEnabled bool

+ KeyOptions struct{ ... }

+ MinReplicationFactor int

+ NumberOfShards int

+ ReplicationFactor ReplicationFactor

+ ShardKeys []string

+ ShardingStrategy ShardingStrategy

+ WaitForSync bool

+ WriteConcern int

+ type CollectionIndexes interface

+ DeleteIndex func(ctx context.Context, name string) error

+ DeleteIndexByID func(ctx context.Context, id string) error

+ EnsureGeoIndex func(ctx context.Context, fields []string, options *CreateGeoIndexOptions) (IndexResponse, bool, error)

+ EnsureInvertedIndex func(ctx context.Context, options *InvertedIndexOptions) (IndexResponse, bool, error)

+ EnsurePersistentIndex func(ctx context.Context, fields []string, options *CreatePersistentIndexOptions) (IndexResponse, bool, error)

+ EnsureTTLIndex func(ctx context.Context, fields []string, expireAfter int, ...) (IndexResponse, bool, error)

+ EnsureZKDIndex func(ctx context.Context, fields []string, options *CreateZKDIndexOptions) (IndexResponse, bool, error)

+ Index func(ctx context.Context, name string) (IndexResponse, error)

+ IndexExists func(ctx context.Context, name string) (bool, error)

+ Indexes func(ctx context.Context) ([]IndexResponse, error)

+ type CollectionInfo struct

+ GloballyUniqueId string

+ ID string

+ IsSystem bool

+ Name string

+ Status CollectionStatus

+ Type CollectionType

+ type CollectionKeyOptions struct

+ AllowUserKeys bool

+ AllowUserKeysPtr *bool

+ Increment int

+ Offset int

+ Type KeyGeneratorType

+ func (c *CollectionKeyOptions) Init()

+ type CollectionProperties struct

+ DistributeShardsLike string

+ DoCompact bool

+ JournalSize int64

+ Schema *CollectionSchemaOptions

+ SmartJoinAttribute string

+ SyncByRevision bool

+ UsesRevisionsAsDocumentIds bool

+ func (p *CollectionProperties) IsSatellite() bool

+ type CollectionSchemaLevel string

+ const CollectionSchemaLevelModerate

+ const CollectionSchemaLevelNew

+ const CollectionSchemaLevelNone

+ const CollectionSchemaLevelStrict

+ type CollectionSchemaOptions struct

+ Level CollectionSchemaLevel

+ Message string

+ Rule interface{}

+ func (d *CollectionSchemaOptions) LoadRule(data []byte) error

+ type CollectionShards struct

+ IsSmart bool

+ Shards map[ShardID][]ServerID

+ StatusString string

+ type CollectionStatistics struct

+ Count int64

+ Figures struct{ ... }

+ JournalSize int64

+ type CollectionStatus int

+ type CollectionType int

+ type CommitTransactionOptions struct

+ type ConsolidationPolicy struct

+ Type ConsolidationPolicyType

+ type ConsolidationPolicyBytesAccum struct

+ Threshold *float64

+ type ConsolidationPolicyTier struct

+ MinScore *int64

+ SegmentsBytesFloor *int64

+ SegmentsBytesMax *int64

+ SegmentsMax *int64

+ SegmentsMin *int64

+ type ConsolidationPolicyType string

+ const ConsolidationPolicyTypeBytesAccum

+ const ConsolidationPolicyTypeTier

+ type CreateCollectionOptions struct

+ CacheEnabled *bool

+ DistributeShardsLike string

+ DoCompact *bool

+ IndexBuckets int

+ InternalValidatorType int

+ IsDisjoint bool

+ IsSmart bool

+ IsSystem bool

+ IsVolatile bool

+ JournalSize int

+ KeyOptions *CollectionKeyOptions

+ MinReplicationFactor int

+ NumberOfShards int

+ ReplicationFactor ReplicationFactor

+ Schema *CollectionSchemaOptions

+ ShardKeys []string

+ ShardingStrategy ShardingStrategy

+ SmartGraphAttribute string

+ SmartJoinAttribute string

+ SyncByRevision bool

+ Type CollectionType

+ WaitForSync bool

+ WriteConcern int

+ func (c *CreateCollectionOptions) Init()

+ type CreateDatabaseDefaultOptions struct

+ ReplicationFactor ReplicationFactor

+ ReplicationVersion DatabaseReplicationVersion

+ Sharding DatabaseSharding

+ WriteConcern int

+ type CreateDatabaseOptions struct

+ Options CreateDatabaseDefaultOptions

+ Users []CreateDatabaseUserOptions

+ type CreateDatabaseUserOptions struct

+ Active *bool

+ Extra interface{}

+ Password string

+ UserName string

+ type CreateGeoIndexOptions struct

+ GeoJSON *bool

+ LegacyPolygons *bool

+ Name string

+ type CreatePersistentIndexOptions struct

+ CacheEnabled *bool

+ Deduplicate *bool

+ Estimates *bool

+ Name string

+ Sparse *bool

+ StoredValues []string

+ Unique *bool

+ type CreateTTLIndexOptions struct

+ Name string

+ type CreateZKDIndexOptions struct

+ FieldValueTypes ZKDFieldType

+ Name string

+ type Cursor interface

+ CloseWithContext func(ctx context.Context) error

+ Count func() int64

+ HasMore func() bool

+ Plan func() CursorPlan

+ ReadDocument func(ctx context.Context, result interface{}) (DocumentMeta, error)

+ Statistics func() CursorStats

+ type CursorBatch interface

+ CloseWithContext func(ctx context.Context) error

+ Count func() int64

+ HasMoreBatches func() bool

+ Plan func() CursorPlan

+ ReadNextBatch func(ctx context.Context, result interface{}) error

+ RetryReadBatch func(ctx context.Context, result interface{}) error

+ Statistics func() CursorStats

+ type CursorPlan struct

+ Collections []CursorPlanCollection

+ EstimatedCost float64

+ EstimatedNrItems int

+ IsModificationQuery bool

+ Nodes []CursorPlanNodes

+ Rules []string

+ Variables []CursorPlanVariable

+ type CursorPlanCollection struct

+ Name string

+ Type string

+ type CursorPlanNodes map[string]interface

+ type CursorPlanVariable struct

+ ID int

+ IsDataFromCollection bool

+ IsFullDocumentFromCollection bool

+ Name string

+ type CursorStats struct

+ CacheHits uint64

+ CacheMisses uint64

+ CursorsCreated uint64

+ CursorsRearmed uint64

+ ExecutionTimeInt float64

+ FilteredInt int64

+ FullCountInt int64

+ HTTPRequests uint64

+ PeakMemoryUsage uint64

+ ScannedFullInt int64

+ ScannedIndexInt int64

+ WritesExecutedInt int64

+ WritesIgnoredInt int64

+ type Database interface

+ Info func(ctx context.Context) (DatabaseInfo, error)

+ Name func() string

+ Remove func(ctx context.Context) error

+ type DatabaseCollection interface

+ Collection func(ctx context.Context, name string) (Collection, error)

+ CollectionExists func(ctx context.Context, name string) (bool, error)

+ Collections func(ctx context.Context) ([]Collection, error)

+ CreateCollection func(ctx context.Context, name string, options *CreateCollectionOptions) (Collection, error)

+ type DatabaseInfo struct

+ ID string

+ IsSystem bool

+ Name string

+ Path string

+ ReplicationFactor ReplicationFactor

+ ReplicationVersion DatabaseReplicationVersion

+ Sharding DatabaseSharding

+ WriteConcern int

+ type DatabaseQuery interface

+ ExplainQuery func(ctx context.Context, query string, bindVars map[string]interface{}, ...) (ExplainQueryResult, error)

+ Query func(ctx context.Context, query string, opts *QueryOptions) (Cursor, error)

+ QueryBatch func(ctx context.Context, query string, opts *QueryOptions, result interface{}) (CursorBatch, error)

+ ValidateQuery func(ctx context.Context, query string) error

+ type DatabaseReplicationVersion string

+ const DatabaseReplicationVersionOne

+ const DatabaseReplicationVersionTwo

+ type DatabaseSharding string

+ const DatabaseShardingNone

+ const DatabaseShardingSingle

+ type DatabaseStreamingTransactions interface

+ AbortTransaction func(ctx context.Context, tid TransactionID, opts *AbortTransactionOptions) error

+ BeginTransaction func(ctx context.Context, cols TransactionCollections, ...) (TransactionID, error)

+ CommitTransaction func(ctx context.Context, tid TransactionID, opts *CommitTransactionOptions) error

+ TransactionStatus func(ctx context.Context, tid TransactionID) (TransactionStatusRecord, error)

+ type DatabaseTransaction interface

+ BeginTransaction func(ctx context.Context, cols TransactionCollections, ...) (Transaction, error)

+ ListTransactions func(ctx context.Context) ([]Transaction, error)

+ ListTransactionsWithStatuses func(ctx context.Context, statuses ...TransactionStatus) ([]Transaction, error)

+ Transaction func(ctx context.Context, id TransactionID) (Transaction, error)

+ WithTransaction func(ctx context.Context, cols TransactionCollections, ...) error

+ type DocumentID string

+ type DocumentMeta struct

+ ID DocumentID

+ Key string

+ Rev string

+ type DocumentMetaSlice []DocumentMeta

+ func (l DocumentMetaSlice) IDs() []DocumentID

+ func (l DocumentMetaSlice) Keys() []string

+ func (l DocumentMetaSlice) Revs() []string

+ type EngineInfo struct

+ Type EngineType

+ type EngineType string

+ func (t EngineType) String() string

+ type ExplainQueryOptimizerOptions struct

+ Rules []string

+ type ExplainQueryOptions struct

+ AllPlans bool

+ MaxNumberOfPlans *int

+ Optimizer ExplainQueryOptimizerOptions

+ type ExplainQueryResult struct

+ Cacheable *bool

+ Plan ExplainQueryResultPlan

+ Plans []ExplainQueryResultPlan

+ Stats ExplainQueryResultExecutionStats

+ Warnings []string

+ type ExplainQueryResultExecutionCollection struct

+ Name string

+ Type string

+ type ExplainQueryResultExecutionNodeRaw map[string]interface

+ type ExplainQueryResultExecutionStats struct

+ ExecutionTime float64

+ PeakMemoryUsage uint64

+ PlansCreated int

+ RulesExecuted int

+ RulesSkipped int

+ type ExplainQueryResultExecutionVariable struct

+ ID int

+ IsDataFromCollection bool

+ IsFullDocumentFromCollection bool

+ Name string

+ type ExplainQueryResultPlan struct

+ Collections []ExplainQueryResultExecutionCollection

+ EstimatedCost float64

+ EstimatedNrItems int

+ NodesRaw []ExplainQueryResultExecutionNodeRaw

+ Rules []string

+ Variables []ExplainQueryResultExecutionVariable

+ type IndexOptions struct

+ CacheEnabled *bool

+ Deduplicate *bool

+ Estimates *bool

+ ExpireAfter *int

+ Fields []string

+ GeoJSON *bool

+ LegacyPolygons *bool

+ MinLength *int

+ SelectivityEstimate float64

+ StoredValues []string

+ type IndexResponse struct

+ InvertedIndex *InvertedIndexOptions

+ Name string

+ RegularIndex *IndexOptions

+ Type IndexType

+ func (i *IndexResponse) UnmarshalJSON(data []byte) error

+ type IndexSharedOptions struct

+ ID string

+ IsNewlyCreated *bool

+ Sparse *bool

+ Unique *bool

+ type IndexType string

+ type InvertedIndexField struct

+ Analyzer string

+ Cache *bool

+ Features []AnalyzerFeature

+ IncludeAllFields *bool

+ Name string

+ Nested []InvertedIndexNestedField

+ SearchField *bool

+ TrackListPositions bool

+ type InvertedIndexNestedField struct

+ Analyzer string

+ Cache *bool

+ Features []AnalyzerFeature

+ Name string

+ Nested []InvertedIndexNestedField

+ SearchField *bool

+ type InvertedIndexOptions struct

+ Analyzer string

+ Cache *bool

+ CleanupIntervalStep *int64

+ CommitIntervalMsec *int64

+ ConsolidationIntervalMsec *int64

+ ConsolidationPolicy *ConsolidationPolicy

+ Features []AnalyzerFeature

+ Fields []InvertedIndexField

+ IncludeAllFields *bool

+ Name string

+ OptimizeTopK []string

+ Parallelism *int

+ PrimaryKeyCache *bool

+ PrimarySort *PrimarySort

+ SearchField *bool

+ StoredValues []StoredValue

+ TrackListPositions bool

+ WriteBufferActive *int64

+ WriteBufferIdle *int64

+ WriteBufferSizeMax *int64

+ type KeyGeneratorType string

+ type LogLevels map[string]string

+ type LogLevelsGetOptions struct

+ ServerID ServerID

+ type LogLevelsSetOptions struct

+ ServerID ServerID

+ type PrimarySort struct

+ Cache *bool

+ Compression PrimarySortCompression

+ Fields []PrimarySortEntry

+ type PrimarySortCompression string

+ const PrimarySortCompressionLz4

+ const PrimarySortCompressionNone

+ type PrimarySortEntry struct

+ Ascending bool

+ Field string

+ type QueryOptions struct

+ BatchSize int

+ BindVars map[string]interface{}

+ Cache bool

+ Count bool

+ MemoryLimit int64

+ Options QuerySubOptions

+ TTL float64

+ type QueryRequest struct

+ Query string

+ type QuerySubOptions struct

+ AllowRetry bool

+ FillBlockCache bool

+ FullCount bool

+ MaxPlans int

+ MaxRuntime float64

+ Optimizer QuerySubOptionsOptimizer

+ Profile uint

+ SatelliteSyncWait float64

+ ShardIds []string

+ Stream bool

+ type QuerySubOptionsOptimizer struct

+ Rules []string

+ type ReplicationFactor int

+ const ReplicationFactorSatellite

+ func (r *ReplicationFactor) UnmarshalJSON(d []byte) error

+ func (r ReplicationFactor) MarshalJSON() ([]byte, error)

+ type Requests interface

+ Delete func(ctx context.Context, output interface{}, urlParts ...string) (connection.Response, error)

+ Get func(ctx context.Context, output interface{}, urlParts ...string) (connection.Response, error)

+ Head func(ctx context.Context, output interface{}, urlParts ...string) (connection.Response, error)

+ Patch func(ctx context.Context, output, input interface{}, urlParts ...string) (connection.Response, error)

+ Post func(ctx context.Context, output, input interface{}, urlParts ...string) (connection.Response, error)

+ Put func(ctx context.Context, output, input interface{}, urlParts ...string) (connection.Response, error)

+ func NewRequests(connection connection.Connection, urlParts ...string) Requests

+ type ServerHealth struct

+ AdvertisedEndpoint *string

+ CanBeDeleted bool

+ Endpoint string

+ Engine EngineType

+ HostID string

+ LastHeartbeatAcked time.Time

+ LastHeartbeatSent time.Time

+ LastHeartbeatStatus string

+ Leader *string

+ Leading *bool

+ Role ServerRole

+ ShortName string

+ Status ServerStatus

+ SyncStatus ServerSyncStatus

+ Version Version

+ type ServerID string

+ type ServerRole string

+ const ServerRoleAgent

+ const ServerRoleCoordinator

+ const ServerRoleDBServer

+ const ServerRoleSingle

+ const ServerRoleSingleActive

+ const ServerRoleSinglePassive

+ const ServerRoleUndefined

+ func ConvertServerRole(arangoDBRole string) ServerRole

+ type ServerStatus string

+ const ServerStatusBad

+ const ServerStatusFailed

+ const ServerStatusGood

+ type ServerSyncStatus string

+ const ServerSyncStatusServing

+ const ServerSyncStatusShutdown

+ const ServerSyncStatusStartup

+ const ServerSyncStatusStopped

+ const ServerSyncStatusStopping

+ const ServerSyncStatusUndefined

+ const ServerSyncStatusUnknown

+ type SetCollectionPropertiesOptions struct

+ CacheEnabled *bool

+ JournalSize int64

+ MinReplicationFactor int

+ ReplicationFactor ReplicationFactor

+ Schema *CollectionSchemaOptions

+ WaitForSync *bool

+ WriteConcern int

+ type ShardID string

+ type ShardingStrategy string

+ const ShardingStrategyCommunityCompat

+ const ShardingStrategyEnterpriseCompat

+ const ShardingStrategyEnterpriseHashSmartEdge

+ const ShardingStrategyEnterpriseSmartEdgeCompat

+ const ShardingStrategyHash

+ type SortDirection string

+ const SortDirectionAsc

+ const SortDirectionDesc

+ type StoredValue struct

+ Cache *bool

+ Compression PrimarySortCompression

+ Fields []string

+ type Transaction interface

+ Abort func(ctx context.Context, opts *AbortTransactionOptions) error

+ Commit func(ctx context.Context, opts *CommitTransactionOptions) error

+ ID func() TransactionID

+ Status func(ctx context.Context) (TransactionStatusRecord, error)

+ type TransactionCollections struct

+ Exclusive []string

+ Read []string

+ Write []string

+ type TransactionID string

+ type TransactionStatus string

+ const TransactionAborted

+ const TransactionCommitted

+ const TransactionRunning

+ type TransactionStatusRecord struct

+ Status TransactionStatus

+ type TransactionStatuses []TransactionStatus

+ func (t TransactionStatuses) Contains(status TransactionStatus) bool

+ type TransactionWrap func(ctx context.Context, t Transaction) error

+ type UnmarshalInto struct

+ func (u *UnmarshalInto) UnmarshalJSON(d []byte) error

+ type Version string

+ func (v Version) CompareTo(other Version) int

+ func (v Version) Major() int

+ func (v Version) Minor() int

+ func (v Version) Sub() string

+ func (v Version) SubInt() (int, bool)

+ type VersionInfo struct

+ Details map[string]interface{}

+ License string

+ Server string

+ Version Version

+ func (v *VersionInfo) IsEnterprise() bool

+ func (v VersionInfo) String() string

+ type ZKDFieldType string

+ const ZKDDoubleFieldType

v2.0.0-alpha.1

May 30, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL