Arangodb Go Driver

https://pkg.go.dev/github.com/arangodb/go-driver/v2
Admin
The Arangodb Go Driver provides a comprehensive interface for Go applications to interact with...
Tokens:86,431
Snippets:619
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Define BeginTransactionOptions struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for starting a transaction in ArangoDB.

```go
type BeginTransactionOptions struct {
	// Set this to true to allow the Coordinator to ask any shard replica for the data, not only the shard leader.
	// This may result in “dirty reads”.
	AllowDirtyReads *bool `json:"-"`

	// Allow reading from undeclared collections.
	AllowImplicit bool `json:"allowImplicit,omitempty"`

	// An optional numeric value that can be used to set a timeout in seconds for waiting on collection locks.
	// This option is only meaningful when using exclusive locks. If not specified, a default value will be used.
	// Setting lockTimeout to 0 will make ArangoDB not time out waiting for a lock.
	LockTimeout float64 `json:"lockTimeout,omitempty"`

	// Transaction size limit in bytes.
	MaxTransactionSize uint64 `json:"maxTransactionSize,omitempty"`

	// Whether to disable fast locking for write operations.
	//
	// Skipping the fast lock round can be faster overall if there are many concurrent Stream Transactions queued that
	// all try to lock the same collection exclusively. It avoids deadlocking and retrying which can occur with the fast
	// locking by guaranteeing a deterministic locking order at the expense of each actual locking operation taking longer.
	//
	// Fast locking should not be skipped for read-only Stream Transactions because it degrades performance if there
	// are no concurrent transactions that use exclusive locks on the same collection.
	SkipFastLockRound bool `json:"skipFastLockRound,omitempty"`

	// An optional boolean flag that, if set, will force the transaction to write all data to disk before returning.
	WaitForSync bool `json:"waitForSync,omitempty"`
```

--------------------------------

### GET /_db/_system/_admin/support-info

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Retrieves details about the current deployment and server environment.

```APIDOC
## GET /_db/_system/_admin/support-info

### Description
Provides details about the current deployment and server environment.

### Method
GET

### Endpoint
/_db/_system/_admin/support-info

### Response
#### Success Response (200)
- **deployment** (DeploymentInfo) - Deployment information (single or cluster, with related details)
- **host** (ServerInfo) - Host/server details (only present in single-server mode)
- **date** (string) - Timestamp when the data was collected
```

--------------------------------

### Define ClientFoxxService interface

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Defines methods for managing Foxx services, including installation, configuration, and dependency management.

```go
type ClientFoxxService interface {
	// InstallFoxxService installs a new service at a given mount path.
	InstallFoxxService(ctx context.Context, dbName string, zipFile string, options *FoxxDeploymentOptions) error
	// UninstallFoxxService uninstalls service at a given mount path.
	UninstallFoxxService(ctx context.Context, dbName string, options *FoxxDeleteOptions) error
	// ListInstalledFoxxServices retrieves the list of Foxx services installed in the specified database.
	// If excludeSystem is true, system services (like _admin/aardvark) will be excluded from the result,
	// returning only custom-installed Foxx services.
	ListInstalledFoxxServices(ctx context.Context, dbName string, excludeSystem *bool) ([]FoxxServiceListItem, error)
	// GetInstalledFoxxService retrieves detailed information about a specific Foxx service
	// installed in the specified database.
	// The service is identified by its mount path, which must be provided and non-empty.
	// If the mount path is missing or empty, a RequiredFieldError is returned.
	// The returned FoxxServiceObject contains the full metadata and configuration details
	// for the specified service.
	GetInstalledFoxxService(ctx context.Context, dbName string, mount *string) (FoxxServiceObject, error)
	// ReplaceFoxxService removes the service at the given mount path from the database and file system
	// and installs the given new service at the same mount path.
	ReplaceFoxxService(ctx context.Context, dbName string, zipFile string, opts *FoxxDeploymentOptions) error
	// UpgradeFoxxService installs the given new service on top of the service currently installed
	// at the specified mount path, retaining the existing service’s configuration and dependencies.
	// This should be used only when upgrading to a newer or equivalent version of the same service.
	UpgradeFoxxService(ctx context.Context, dbName string, zipFile string, opts *FoxxDeploymentOptions) error
	// GetFoxxServiceConfiguration retrieves the configuration values for the Foxx service
	// mounted at the specified path in the given database.
	// The mount parameter must not be nil or empty.
	// Returns a map containing the current configuration key-value pairs.
	GetFoxxServiceConfiguration(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)
	// UpdateFoxxServiceConfiguration updates the configuration of a specific Foxx service.
	// If the Foxx service does not allow a particular configuration key, it will appear
	// in the response warnings.
	// The caller is responsible for validating allowed keys before calling this method.
	UpdateFoxxServiceConfiguration(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)
	// ReplaceFoxxServiceConfiguration replaces the given Foxx service's dependencies entirely.
	// If the Foxx service does not allow a particular configuration key, it will appear
	// in the response warnings.
	// The caller is responsible for validating allowed keys before calling this method.
	ReplaceFoxxServiceConfiguration(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)

	// GetFoxxServiceDependencies retrieves the configured dependencies for a specific Foxx service.
	// Returns:
	// A map where each key is a dependency name and the value is an object containing:
	// 	* title: Human-readable title of the dependency
	//  * mount: Current mount path of the dependency service (if set)
	// An error if the request fails or the mount is missing.
	GetFoxxServiceDependencies(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)
	// UpdateFoxxServiceDependencies updates the configured dependencies of a specific Foxx service.
	// If the Foxx service does not allow a particular dependency key, it will appear
	// in the "warnings" field of the response.
	// The caller is responsible for ensuring that only allowed dependency keys are provided.
	UpdateFoxxServiceDependencies(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)
	// ReplaceFoxxServiceDependencies replaces the given Foxx service's dependencies entirely.
}
```

--------------------------------

### Define Foxx Service Objects

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structures representing installed Foxx services and their metadata.

```go
type FoxxServiceListItem struct {
	CommonFoxxServiceFields
	// Provides lists the capabilities or interfaces the service provides.
	// This is a flexible map that may contain metadata like API contracts or service roles.
	Provides map[string]interface{} `json:"provides"`
}
```

```go
type FoxxServiceObject struct {
	// Common fields for all Foxx services.
	CommonFoxxServiceFields

	// Path is the local filesystem path where the service is installed.
	Path *string `json:"path,omitempty"`

	// Manifest contains the normalized manifest.json of the service.
	Manifest *Manifest `json:"manifest,omitempty"`

	// Options contains optional runtime options defined for the service.
	Options map[string]interface{} `json:"options,omitempty"`
}
```

--------------------------------

### Initialize New Client

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Creates a new client instance using the provided connection.

```go
func NewClient(connection connection.Connection) Client
```

--------------------------------

### Deployment and Service Structures

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structures for Foxx service deployment and deployment identification.

```go
type DeployFoxxServiceRequest struct {
	FoxxDeploymentOptions `json:",inline"`
}
```

```go
type DeploymentIdResponse struct {
	// Id represents the unique deployment identifier
	Id *string `json:"id"`
}
```

```go
type DeploymentInfo struct {
	// Type of deployment ("single" or "cluster")
	Type *string `json:"type,omitempty"`
```

--------------------------------

### Define LogSettingsOptions struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for log settings.

```go
type LogSettingsOptions struct {
	// Database indicates whether the database name should be included
```

--------------------------------

### QueryPlanCacheRespObject Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Represents a single entry from the GET _api/query-plan-cache endpoint.

```go
type QueryPlanCacheRespObject struct {
	CacheRespObject `json:",inline"`
	// QueryHash is the hash of the AQL query string.
	QueryHash *uint64 `json:"queryHash,omitempty"`
	// FullCount indicates whether the query result contains the full count of documents.
	FullCount *bool `json:"fullCount,omitempty"`
	// Created is the time when the query plan has been added to the cache.
	Created *string `json:"created,omitempty"`
	// MemoryUsage is the memory usage of the cached plan in bytes.
	// This is the amount of memory used by the cached plan on the server.
	MemoryUsage *uint64 `json:"memoryUsage,omitempty"`
}
```

--------------------------------

### Get response error number

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb/shared

Retrieves the ArangoDB-specific error number.

```go
func (r Response) GetErrorNum() int
```

--------------------------------

### HTTP and HTTP2 Connection Initialization

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/connection

Functions to initialize HTTP and HTTP2 connections. Note that VST should be disabled when using NewHttp2Connection to prevent performance issues.

```go
func NewHttp2Connection(config Http2Configuration) Connection
```

```go
func NewHttpConnection(config HttpConfiguration) Connection
```

--------------------------------

### GET _api/query-plan-cache

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Retrieves the list of cached query plans from the ArangoDB server.

```APIDOC
## GET _api/query-plan-cache

### Description
Retrieves the current query plan cache entries from the ArangoDB server.

### Method
GET

### Endpoint
_api/query-plan-cache

### Response
#### Success Response (200)
- **queryHash** (uint64) - The hash of the AQL query string.
- **fullCount** (bool) - Indicates whether the query result contains the full count of documents.
- **created** (string) - The time when the query plan was added to the cache.
- **memoryUsage** (uint64) - The memory usage of the cached plan in bytes.
```

--------------------------------

### Initialize Requests

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Constructor function for creating a new Requests instance.

```go
func NewRequests(connection connection.Connection, urlParts ...string) Requests
```

--------------------------------

### Define ExplainQueryOptimizerOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configures optimizer rules for query explanation. Prefix rule names with '+' to enable or '-' to disable.

```go
type ExplainQueryOptimizerOptions struct {
	// A list of to-be-included or to-be-excluded optimizer rules can be put into this attribute,
	// telling the optimizer to include or exclude specific rules.
	//  To disable a rule, prefix its name with a "-", to enable a rule, prefix it with a "+".
	// There is also a pseudo-rule "all", which matches all optimizer rules. "-all" disables all rules.
	Rules []string `json:"rules,omitempty"`
}
```

--------------------------------

### Get response error message

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb/shared

Retrieves the error message string from the response.

```go
func (r Response) GetErrorMessage() string
```

--------------------------------

### Get response status code

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb/shared

Retrieves the HTTP status code from the response.

```go
func (r Response) GetCode() int
```

--------------------------------

### Initialize CreateCollectionPropertiesV2

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Translates deprecated fields into current ones for backward compatibility.

```go
func (c *CreateCollectionPropertiesV2) Init()
```

--------------------------------

### Get Ascending Property

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Retrieves the Ascending boolean value, defaulting to false if unset.

```go
func (pse ArangoSearchPrimarySortEntry) GetAscending() bool
```

--------------------------------

### GetVersionOptions Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for retrieving database version information.

```go
type GetVersionOptions struct {
	// If true, additional details will be returned in response
	// Default false
	Details *bool
}
```

--------------------------------

### KeyOpts Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Represents options for document key generation.

```go
type KeyOpts struct {
	// Whether user-supplied keys are allowed
	AllowUserKeys *bool `json:"allowUserKeys,omitempty"`
	// Key type (autoincrement, traditional, etc.)
	Type *string `json:"type,omitempty"`
	// Internal offset for autoincrement/padded key generators.
	// This is read-only server metadata used for dump/restore workflows.
	LastValue *int `json:"lastValue,omitempty"`
}
```

--------------------------------

### Foxx Service Management

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Methods for managing Foxx services, including installation, uninstallation, configuration updates, and dependency management.

```APIDOC
## Foxx Service Operations

### InstallFoxxService(ctx context.Context, dbName string, zipFile string, options *FoxxDeploymentOptions) error
Installs a new service at a given mount path.

### UninstallFoxxService(ctx context.Context, dbName string, options *FoxxDeleteOptions) error
Uninstalls a service at a given mount path.

### ListInstalledFoxxServices(ctx context.Context, dbName string, excludeSystem *bool) ([]FoxxServiceListItem, error)
Retrieves the list of Foxx services installed in the specified database.

### GetInstalledFoxxService(ctx context.Context, dbName string, mount *string) (FoxxServiceObject, error)
Retrieves detailed information about a specific Foxx service installed in the specified database.

### ReplaceFoxxService(ctx context.Context, dbName string, zipFile string, opts *FoxxDeploymentOptions) error
Removes the service at the given mount path and installs a new service at the same path.

### UpgradeFoxxService(ctx context.Context, dbName string, zipFile string, opts *FoxxDeploymentOptions) error
Installs a new service on top of the existing service at the specified mount path, retaining configuration and dependencies.

### GetFoxxServiceConfiguration(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)
Retrieves the configuration values for the Foxx service mounted at the specified path.

### UpdateFoxxServiceConfiguration(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)
Updates the configuration of a specific Foxx service.

### ReplaceFoxxServiceConfiguration(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)
Replaces the given Foxx service's configuration entirely.

### GetFoxxServiceDependencies(ctx context.Context, dbName string, mount *string) (map[string]interface{}, error)
Retrieves the configured dependencies for a specific Foxx service.

### UpdateFoxxServiceDependencies(ctx context.Context, dbName string, mount *string, opt map[string]interface{}) (map[string]interface{}, error)
Updates the configured dependencies of a specific Foxx service.
```

--------------------------------

### User Options

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for creating or updating users.

```go
type UserOptions struct {
	// The user password as a string. If not specified, it will default to an empty string.
	Password string `json:"passwd,omitempty"`

	// An optional flag that specifies whether the user is active. If not specified, this will default to true.
	Active *bool `json:"active,omitempty"`

	// A JSON object with extra user information.
	// The data contained in extra will be stored for the user but not be interpreted further by ArangoDB.
	Extra interface{} `json:"extra,omitempty"`
}
```

--------------------------------

### Define BackupCreateOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for creating database backups, including timeout and consistency settings.

```go
type BackupCreateOptions struct {
	// The label for this backup.
	// The label is used together with a timestamp string create a unique backup identifier, <timestamp>_<label>.
	// Default: If omitted or empty, a UUID will be generated.
	Label string `json:"label,omitempty"`

	// The time in seconds that the operation tries to get a consistent snapshot. The default is 120 seconds.
	Timeout *uint `json:"timeout,omitempty"`

	// If set to `true` and no global transaction lock can be acquired within the
	// given timeout, a possibly inconsistent backup is taken.
	AllowInconsistent *bool `json:"allowInconsistent,omitempty"`

	// (Cluster only; Enterprise Edition; from v3.12.5 onward also in Community Edition.) If set to `true` and no global transaction lock can be acquired within the
	// given timeout, all running transactions are forcefully aborted to ensure that a consistent backup can be created.
	Force *bool `json:"force,omitempty"`
}
```

--------------------------------

### Define CreateCollectionOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structure for collection creation options.

```go
type CreateCollectionOptions struct {
	// EnforceReplicationFactor the default is true, which means the server checks if there are enough replicas available
```

--------------------------------

### SupportInfoResponse Struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Represents the response from the support-info endpoint, containing deployment and host details.

```go
type SupportInfoResponse struct {
	// Deployment information (single or cluster, with related details)
	Deployment DeploymentInfo `json:"deployment"`

	// Host/server details (only present in single-server mode)
	Host *ServerInfo `json:"host,omitempty"`

	// Timestamp when the data was collected
	Date *string `json:"date,omitempty"`
}
```

--------------------------------

### Vector Index Parameters

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration parameters for vector index creation and search.

```go
type VectorParams struct {
	// Neighbors considered in search.
	DefaultNProbe *int `json:"defaultNProbe,omitempty"`
	// Vector length.
	Dimension *int `json:"dimension,omitempty"`
	// Faiss factory string.
	Factory *string `json:"factory,omitempty"`
	// Similarity measure.
	Metric *VectorMetric `json:"metric,omitempty"`
	// Number of centroids.
	NLists *int `json:"nLists,omitempty"`
	// Faiss training iterations
	TrainingIterations *int `json:"trainingIterations,omitempty"`
}
```

--------------------------------

### Configuration Structures

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/connection

Configuration structs for HTTP and HTTP2 connections, including helper functions for default wrappers.

```go
type Http2Configuration struct {
	Authentication Authentication
	Endpoint       Endpoint

	ContentType string

	ArangoDBConfig ArangoDBConfiguration

	Transport *http2.Transport
}
```

```go
func DefaultHTTP2ConfigurationWrapper(endpoint Endpoint, insecureSkipVerify bool) Http2Configuration
```

```go
type HttpConfiguration struct {
	Authentication Authentication
	Endpoint       Endpoint

	ContentType string

	ArangoDBConfig ArangoDBConfiguration

	Transport http.RoundTripper

	// DontFollowRedirect; if set, redirect will not be followed, response from the initial request will be returned without an error
	// DontFollowRedirect takes precendance over FailOnRedirect.
	DontFollowRedirect bool
}
```

```go
func DefaultHTTPConfigurationWrapper(endpoint Endpoint, insecureSkipVerify bool) HttpConfiguration
```

--------------------------------

### Define Foxx Service Options

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structures for managing Foxx service lifecycle and deployment.

```go
type FoxxDeleteOptions struct {
	Mount    *string
	Teardown *bool
}
```

```go
type FoxxDeploymentOptions struct {
	Mount *string
}
```

--------------------------------

### Manage Databases

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Interface for connecting to, checking existence of, and listing databases.

```go
type ClientDatabase interface {
	// GetDatabase opens a connection to an existing database.
	// If no database with given name exists, an NotFoundError is returned.
	GetDatabase(ctx context.Context, name string, options *GetDatabaseOptions) (Database, error)

	// DatabaseExists returns true if a database with given name exists.
	DatabaseExists(ctx context.Context, name string) (bool, error)

	// Databases returns a list of all databases found by the client.
	Databases(ctx context.Context) ([]Database, error)

	// AccessibleDatabases returns a list of all databases that can be accessed by the authenticated user.
	AccessibleDatabases(ctx context.Context) ([]Database, error)
```

--------------------------------

### ServerProgress Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Contains information about the startup or recovery phase of the server.

```go
type ServerProgress struct {
	// Current phase of the server (e.g., "in wait")
	Phase *string `json:"phase,omitempty"`
	// Current feature being processed (if any)
	Feature *string `json:"feature,omitempty"`
	// Recovery tick value
	RecoveryTick *int `json:"recoveryTick,omitempty"`
}
```

--------------------------------

### Define CreateTTLIndexOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for creating a Time-To-Live (TTL) index.

```go
type CreateTTLIndexOptions struct {
	// Name optional user defined name used for hints in AQL queries
	Name string `json:"name,omitempty"`

	// InBackground You can set this option to true to create the index in the background,
	// which will not write-lock the underlying collection for as long as if the index is built in the foreground.
	// The default value is false.
	InBackground *bool `json:"inBackground,omitempty"`
}
```

--------------------------------

### Define CreateDatabaseOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration structure for defining initial users when creating a new database.

```go
type CreateDatabaseOptions struct {
	// List of users to initially create for the new database. User information will not be changed for users that already exist.
	// If users is not specified or does not contain any users, a default user root will be created with an empty string password.
	// This ensures that the new database will be accessible after it is created.
	Users []CreateDatabaseUserOptions `json:"users,omitempty"`
```

--------------------------------

### Define CreateMDIIndexOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration for creating Multi-Dimensional Index (MDI) indexes.

```go
type CreateMDIIndexOptions struct {
	// Name optional user defined name used for hints in AQL queries
	Name string `json:"name,omitempty"`

	// FieldValueTypes is required and the only allowed value is "double".
	//Future extensions of the index will allow other types.
	FieldValueTypes MDIFieldType `json:"fieldValueTypes,required"`

	// Unique if true, then create a unique index.
	Unique *bool `json:"unique,omitempty"`

	// Sparse If `true`, then create a sparse index to exclude documents from the index that do not have the defined
	// attributes or are explicitly set to `null` values. If a non-value is set, it still needs to be numeric.
	Sparse *bool `json:"sparse,omitempty"`
}
```

--------------------------------

### Define CreateGeoIndexOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration for creating geo-spatial indexes, including GeoJSON support and background indexing.

```go
type CreateGeoIndexOptions struct {
	// Name optional user defined name used for hints in AQL queries
	Name string `json:"name,omitempty"`

	// If a geo-spatial index on a location is constructed and GeoJSON is true, then the order within the array
	// is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions
	GeoJSON *bool `json:"geoJson,omitempty"`

	// LegacyPolygons determines if the to-be-created index should use legacy polygons or not.
	// It is relevant for those that have geoJson set to true only.
	// Old geo indexes from versions from below 3.10 will always implicitly have the legacyPolygons option set to true.
	// Newly generated geo indexes from 3.10 on will have the legacyPolygons option by default set to false,
	// however, it can still be explicitly overwritten with true to create a legacy index but is not recommended.
	LegacyPolygons *bool `json:"legacyPolygons,omitempty"`

	// InBackground You can set this option to true to create the index in the background,
	// which will not write-lock the underlying collection for as long as if the index is built in the foreground.
	// The default value is false.
	InBackground *bool `json:"inBackground,omitempty"`
}
```

--------------------------------

### User Interface

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Interface for interacting with server users.

```go
type User interface {
	// Name returns the name of the user.
	Name() string

	// IsActive returns whether the user is active.
	IsActive() bool

	// Extra information about this user that was passed during its creation/update/replacement
	Extra(result interface{}) error

	UserPermissions
}
```

--------------------------------

### Compression interface and configuration

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/connection

Defines compression behavior and configuration settings for network requests.

```go
type Compression interface {
	ApplyRequestHeaders(r Request)
	ApplyRequestCompression(r *httpRequest, rootWriter io.Writer) (io.WriteCloser, error)
}
```

```go
type CompressionConfig struct {
	// CompressionConfig is used to enable compression for the requests
	CompressionType CompressionType

	// ResponseCompressionEnabled is used to enable compression for the responses (requires server side adjustments)
	ResponseCompressionEnabled bool

	// RequestCompressionEnabled is used to enable compression for the requests
	RequestCompressionEnabled bool

	// RequestCompressionLevel - Sets the compression level between -1 and 9
	// Default: 0 (NoCompression). For Reference see: https://pkg.go.dev/compress/flate#pkg-constants
	RequestCompressionLevel int
}
```

--------------------------------

### GetDatabase(ctx, name, options)

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Opens a connection to an existing database.

```APIDOC
## GetDatabase

### Description
Opens a connection to an existing database. Returns a NotFoundError if the database does not exist.

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **name** (string) - Required - The name of the database.
- **options** (*GetDatabaseOptions) - Optional - Configuration options for the connection.
```

--------------------------------

### Define Batch Creation Options

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Request body structure for creating a new batch with a specified Time-To-Live (TTL).

```go
type CreateNewBatchOptions struct {
	Ttl int `json:"ttl"`
}
```

--------------------------------

### ZeroLogLogger Implementation

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/log

ZeroLog-based logger implementation and its methods.

```go
type ZeroLogLogger struct {
	// contains filtered or unexported fields
}
```

```go
func (z ZeroLogLogger) Debug(msg string)
```

```go
func (z ZeroLogLogger) Debugf(msg string, args ...interface{})
```

```go
func (z ZeroLogLogger) Error(err error, msg string)
```

```go
func (z ZeroLogLogger) Errorf(err error, msg string, args ...interface{})
```

```go
func (z ZeroLogLogger) Info(msg string)
```

```go
func (z ZeroLogLogger) Infof(msg string, args ...interface{})
```

```go
func (z ZeroLogLogger) Trace(msg string)
```

```go
func (z ZeroLogLogger) Tracef(msg string, args ...interface{})
```

--------------------------------

### WALTailOptions Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for tailing the WAL, including tick bounds and client identification.

```go
type WALTailOptions struct {
	// Global indicates whether operations for all databases should be included.
	// If set to false, only the operations for the current database are included.
	// The value true is only valid on the _system database.
	Global *bool `json:"global,omitempty"`

	// From specifies the exclusive lower bound tick value for the replication.
	From *int64 `json:"from,omitempty"`

	// To specifies the inclusive upper bound tick value for the replication.
	To *int64 `json:"to,omitempty"`

	// LastScanned specifies the last scanned tick value (for RocksDB multi-response support).
	LastScanned *int `json:"lastScanned,omitempty"`

	// ChunkSize specifies the approximate maximum size of the returned result in bytes.
	ChunkSize *int `json:"chunkSize,omitempty"`

	// SyncerId specifies the ID of the client used to tail results.
	// Required if ServerId is not provided.
	SyncerId *int64 `json:"syncerId,omitempty"`

	// ServerId specifies the ID of the client machine.
	// Required if SyncerId is not provided.
	ServerId *int64 `json:"serverId,omitempty"`
}
```

--------------------------------

### Query Configuration Options

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for query execution, including memory management and streaming behavior.

```go
SpillOverThresholdNumRows *int `json:"spillOverThresholdNumRows,omitempty"`
```

```go
Stream bool `json:"stream,omitempty"`
```

```go
MaxPlans int `json:"maxPlans,omitempty"`
```

```go
ShardIds []string `json:"shardIds,omitempty"`
```

--------------------------------

### Define CreateDatabaseDefaultOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration structure for setting default replication, write concern, and sharding for new databases.

```go
type CreateDatabaseDefaultOptions struct {
	// Default replication factor for collections in database
	ReplicationFactor ReplicationFactor `json:"replicationFactor,omitempty"`
	// Default write concern for collections in database
	WriteConcern int `json:"writeConcern,omitempty"`
	// Default sharding for collections in database.
	//
	// Note: server responses may still report this value as empty string,
	// including when DatabaseShardingFlexible was requested.
	Sharding DatabaseSharding `json:"sharding,omitempty"`
	// Replication version to use for this database
	// Available since ArangoDB version 3.11
	ReplicationVersion DatabaseReplicationVersion `json:"replicationVersion,omitempty"`
}
```

--------------------------------

### LogSettingsOptions Struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Represents configurable flags for including specific fields in structured log output.

```go
type LogSettingsOptions struct {
	// in structured log entries.
	Database *bool `json:"database,omitempty"`

	// Url indicates whether the request URL should be included
	// in structured log entries.
	Url *bool `json:"url,omitempty"`

	// Username indicates whether the authenticated username should be included
	// in structured log entries.
	Username *bool `json:"username,omitempty"`
}
```

--------------------------------

### Define CreateVectorIndexOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for creating a vector index, available from v2.2.0.

```go
type CreateVectorIndexOptions struct {
	// InBackground, when true, is sent to the server: index building is deferred until enough data is available,
	// avoiding an immediate error on empty or nearly empty collections. When false or unset, synchronous creation
	// may return an error while still creating an index in unusable state if training data is insufficient.
	// Alternatively, insert embeddings first then create the index without relying on inBackground.
	InBackground *bool `json:"inBackground,omitempty"`
	// Optional index name.
	Name *string `json:"name,omitempty"`
	// Number of threads to use for index creation.
	Parallelism *int `json:"parallelism,omitempty"`
	// Exclude docs missing the field.
	Sparse *bool `json:"sparse,omitempty"`
	// Introduced in v3.12.7
	// Up to 32 additional attributes can be stored in the index.
	StoredValues []string `json:"storedValues,omitempty"`
}
```

--------------------------------

### Define CreateVertexOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for creating a vertex, available from v2.1.0.

```go
type CreateVertexOptions struct {
	// Define if the request should wait until synced to disk.
	WaitForSync *bool `json:"waitForSync,omitempty"`

	// Define if the response should contain the complete new version of the document.
	NewObject interface{}

	// To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the
	// DatabaseTransaction.BeginTransaction() method.
	TransactionID string
}
```

--------------------------------

### Server Version Information

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structure containing metadata about the database server version and license.

```go
type VersionInfo struct {
	// This will always contain "arango"
	Server string `json:"server,omitempty"`

	//  The server version string. The string has the format "major.minor.sub".
	// Major and minor will be numeric, and sub may contain a number or a textual version.
	Version Version `json:"version,omitempty"`

	// Type of license of the server
	License string `json:"license,omitempty"`

	// Optional additional details. This is returned only if details were requested
	Details map[string]interface{} `json:"details,omitempty"`
}
```

```go
func (v VersionInfo) IsEnterprise() bool
```

```go
func (v VersionInfo) String() string
```

--------------------------------

### Define CompactOpts

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for compacting data levels.

```go
type CompactOpts struct {
	//whether or not compacted data should be moved to the minimum possible level.
	ChangeLevel *bool `json:"changeLevel,omitempty"`
	// Whether or not to compact the bottommost level of data.
	CompactBottomMostLevel *bool `json:"compactBottomMostLevel,omitempty"`
}
```

--------------------------------

### ArangoDB Backup Administration Interface

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Provides methods for creating, restoring, deleting, and transferring database backups.

```go
type ClientAdminBackup interface {
	BackupCreate(ctx context.Context, opt *BackupCreateOptions) (BackupResponse, error)
	BackupRestore(ctx context.Context, id string) (BackupRestoreResponse, error)
	BackupDelete(ctx context.Context, id string) error
	BackupList(ctx context.Context, opt *BackupListOptions) (ListBackupsResponse, error)
	BackupUpload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error)
	BackupDownload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error)
	TransferMonitor(jobId string, transferType TransferType) (TransferMonitor, error)
}
```

--------------------------------

### Define LogLevelsGetOptions struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for retrieving log levels, optionally filtered by server ID.

```go
type LogLevelsGetOptions struct {
	// serverID describes log levels for a specific server ID.
	ServerID ServerID
}
```

--------------------------------

### Define ExplainQueryResultPlan

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Details of a specific execution plan, including nodes, applied rules, and estimated costs.

```go
type ExplainQueryResultPlan struct {
	// Execution nodes of the plan.
	NodesRaw []ExplainQueryResultExecutionNodeRaw `json:"nodes,omitempty"`

	// List of rules the optimizer applied
	Rules []string `json:"rules,omitempty"`

	// List of collections used in the query
	Collections []ExplainQueryResultExecutionCollection `json:"collections,omitempty"`

	// List of variables used in the query (note: this may contain internal variables created by the optimizer)
	Variables []ExplainQueryResultExecutionVariable `json:"variables,omitempty"`

	// The total estimated cost for the plan. If there are multiple plans, the optimizer will choose the plan with the lowest total cost
	EstimatedCost float64 `json:"estimatedCost,omitempty"`
}
```

--------------------------------

### Define CreateDatabaseUserOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Use this struct to specify user credentials and activation status when creating a new database user.

```go
type CreateDatabaseUserOptions struct {
	// Loginname of the user to be created
	UserName string `json:"user,omitempty"`
	// The user password as a string. If not specified, it will default to an empty string.
	Password string `json:"passwd,omitempty"`
	// A flag indicating whether the user account should be activated or not. The default value is true. If set to false, the user won't be able to log into the database.
	Active *bool `json:"active,omitempty"`
	// A JSON object with extra user information. The data contained in extra will be stored for the user but not be interpreted further by ArangoDB.
	Extra interface{} `json:"extra,omitempty"`
}
```

--------------------------------

### Define LogLevelsSetOptions struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for setting log levels, optionally filtered by server ID.

```go
type LogLevelsSetOptions struct {
	// serverID describes log levels for a specific server ID.
	ServerID ServerID
}
```

--------------------------------

### Compression types and constants

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/connection

Defines supported compression algorithms.

```go
type CompressionType string
```

```go
const (

	// RequestCompressionTypeGzip is used to enable gzip compression
	RequestCompressionTypeGzip CompressionType = "gzip"

	// RequestCompressionTypeDeflate is used to enable deflate compression
	RequestCompressionTypeDeflate CompressionType = "deflate"
)
```

--------------------------------

### Define CreateEdgeOptions

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Options for creating edges, including synchronization settings and transaction association.

```go
type CreateEdgeOptions struct {
	// Define if the request should wait until synced to disk.
	WaitForSync *bool `json:"waitForSync,omitempty"`

	// Define if the response should contain the complete new version of the document.
	NewObject interface{}

	// To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the
	// DatabaseTransaction.BeginTransaction() method.
	TransactionID string
}
```

--------------------------------

### Define ParametersInventoryResponse struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Contains comprehensive metadata and configuration settings for a collection.

```go
type ParametersInventoryResponse struct {
	// Reusable basic properties like ID and Name
	BasicProperties
	// AllowUserKeys indicates whether user keys are allowed.
	AllowUserKeys *bool `json:"allowUserKeys,omitempty"`
	// CacheEnabled indicates whether in-memory cache is enabled.
	CacheEnabled *bool `json:"cacheEnabled,omitempty"`
	// Cid is the collection ID.
	Cid *string `json:"cid,omitempty"`
	// ComputedValues holds the computed values for the collection.
	ComputedValues interface{} `json:"computedValues,omitempty"`
	// Deleted indicates whether the collection is deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// GloballyUniqueId is the globally unique identifier for the collection.
	GloballyUniqueId *string `json:"globallyUniqueId,omitempty"`
	// InternalValidatorType is the internal validator type.
	InternalValidatorType *int `json:"internalValidatorType,omitempty"`
	// IsDisjoint indicates whether disjoint smart graphs are used.
	IsDisjoint *bool `json:"isDisjoint,omitempty"`
	// IsSmart indicates whether the collection is a smart graph collection.
	IsSmart *bool `json:"isSmart,omitempty"`
	// IsSmartChild indicates whether the collection this is a child shard of a smart graph.
	IsSmartChild *bool `json:"isSmartChild,omitempty"`
	// IsSystem indicates whether the collection is a system collection.
	IsSystem *bool `json:"isSystem,omitempty"`
	// KeyOptions defines the key generation options for the collection.
	KeyOptions *KeyOpts `json:"keyOptions,omitempty"`
	// MinReplicationFactor defines the minimum replication factor for the collection.
	// Deprecated: use WriteConcern instead. This is a legacy alias kept for compatibility.
	MinReplicationFactor *int `json:"minReplicationFactor,omitempty"`
	// NumberOfShards defines the number of shards for the collection.
	NumberOfShards *int `json:"numberOfShards,omitempty"`
	// PlanId is the plan ID for the collection.
	PlanId *string `json:"planId,omitempty"`
	// ReplicationFactor defines the replication factor for the collection.
	ReplicationFactor interface{} `json:"replicationFactor,omitempty"`
	// Schema defines the schema for the collection.
	Schema interface{} `json:"schema,omitempty"`
	// ShardKeys defines the shard keys for the collection.
	ShardKeys []string `json:"shardKeys,omitempty"`
	// ShardingStrategy defines the sharding strategy for the collection.
	ShardingStrategy *string `json:"shardingStrategy,omitempty"`
	// Shards defines the shards for the collection.
	Shards map[string][]string `json:"shards,omitempty"`
	// Status defines the Collection status code.
	Status *int `json:"status,omitempty"`
	// SyncByRevision indicates whether the collection is synced by revision.
	SyncByRevision *bool `json:"syncByRevision,omitempty"`
	// Type defines the Collection type (document/edge).
	Type *int `json:"type,omitempty"`
	// UsesRevisionsAsDocumentIds indicates whether document revisions are used as document IDs.
	UsesRevisionsAsDocumentIds *bool `json:"usesRevisionsAsDocumentIds,omitempty"`
	// Version defines the version of the collection.
	Version *int `json:"version,omitempty"`
	// WaitForSync indicates whether the collection should wait for sync.
	WaitForSync *bool `json:"waitForSync,omitempty"`
	// WriteConcern defines the write concern level for the collection.
	WriteConcern *int `json:"writeConcern,omitempty"`
}
```

--------------------------------

### Version Handling Methods

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Utilities for parsing and comparing ArangoDB server version strings.

```go
type Version string
```

```go
func (v Version) CompareTo(other Version) int
```

```go
func (v Version) Major() int
```

```go
func (v Version) Minor() int
```

```go
func (v Version) Sub() string
```

```go
func (v Version) SubInt() (int, bool)
```

--------------------------------

### Define CoordinatorInfo

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structure for cluster coordinator information.

```go
type CoordinatorInfo struct {
	// ID of the Foxxmaster coordinator. Deprecated: Foxx is planned to be removed in ArangoDB v4.0.
	Foxxmaster *string `json:"foxxmaster,omitempty"`
	// Whether this server is the Foxxmaster. Deprecated: Foxx is planned to be removed in ArangoDB v4.0.
	IsFoxxmaster *bool `json:"isFoxxmaster,omitempty"`
}
```

--------------------------------

### Retrieve Driver Version

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/version

Returns the current version of the driver as a string.

```go
func DriverVersion() string
```

--------------------------------

### Network and URL Utilities

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/connection

Helpers for creating dialers and manipulating URL paths.

```go
func NewHTTP2DialForEndpoint(e Endpoint) func(ctx context.Context, network, addr string, cfg *tls.Config) (net.Conn, error)
```

```go
func NewUrl(parts ...string) string
```

--------------------------------

### Define Import Options Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration structure for controlling document import behavior, including overwrite settings, duplicate handling, and prefixing.

```go
type CollectionDocumentImportOptions struct {
	// IgnoreMissing controls whether rows with missing values are imported when using tabular import format.
	// Missing values are omitted and excess values are ignored.
	IgnoreMissing *bool `json:"ignoreMissing,omitempty"`
	// FromPrefix is an optional prefix for the values in _from attributes. If specified, the value is automatically
	// prepended to each _from input value. This allows specifying just the keys for _from.
	FromPrefix *string `json:"fromPrefix,omitempty"`
	// ToPrefix is an optional prefix for the values in _to attributes. If specified, the value is automatically
	// prepended to each _to input value. This allows specifying just the keys for _to.
	ToPrefix *string `json:"toPrefix,omitempty"`
	// OverwriteCollectionPrefix forces `fromPrefix` and `toPrefix` to be applied even if values already contain a collection prefix.
	OverwriteCollectionPrefix *bool `json:"overwriteCollectionPrefix,omitempty"`
	// Overwrite is a flag that if set, then all data in the collection will be removed prior to the import.
	// Note that any existing index definitions will be preseved.
	Overwrite *bool `json:"overwrite,omitempty"`
	// OnDuplicate controls what action is carried out in case of a unique key constraint violation.
	// Possible values are:
	// - ImportOnDuplicateError
	// - ImportOnDuplicateUpdate
	// - ImportOnDuplicateReplace
	// - ImportOnDuplicateIgnore
	OnDuplicate *CollectionDocumentImportOnDuplicate `json:"onDuplicate,omitempty"`
	// Complete is a flag that if set, will make the whole import fail if any error occurs.
	// Otherwise the import will continue even if some documents cannot be imported.
	Complete *bool `json:"complete,omitempty"`
	// Details includes per-document error details in the import response for failed documents.
	Details *bool `json:"details,omitempty"`
```

--------------------------------

### Define Repository

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Structure describing a Foxx service version control repository.

```go
type Repository struct {
	// Type is the type of repository (e.g., "git").
	Type *string `json:"type,omitempty"`

	// URL is the link to the repository.
	URL *string `json:"url,omitempty"`
}
```

--------------------------------

### Define QueryOptions struct

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configures execution parameters for AQL queries, such as batch size, memory limits, and transaction association.

```go
type QueryOptions struct {
	// Set this to true to allow the Coordinator to ask any shard replica for the data, not only the shard leader.
	// This may result in “dirty reads”.
	// This option is ignored if this operation is part of a DatabaseTransaction (TransactionID option).
	// The header set when creating the transaction decides about dirty reads for the entire transaction,
	// not the individual read operations.
	AllowDirtyReads *bool `json:"-"`

	// To make this operation a part of a Stream Transaction, set this header to the transaction ID returned by the
	// DatabaseTransaction.BeginTransaction() method.
	TransactionID string `json:"-"`

	// Indicates whether the number of documents in the result set should be returned in the "count" attribute of the result.
	// Calculating the "count" attribute might have a performance impact for some queries in the future so this option is
	// turned off by default, and "count" is only returned when requested.
	Count bool `json:"count,omitempty"`

	// maximum number of result documents to be transferred from the server to the client in one roundtrip.
	// If this attribute is not set, a server-controlled default value will be used. A batchSize value of 0 is disallowed.
	BatchSize int `json:"batchSize,omitempty"`

	// flag to determine whether the AQL query cache shall be used. If set to false, then any query cache lookup
	// will be skipped for the query. If set to true, it will lead to the query cache being checked for the query
	// if the query cache mode is either on or demand.
	Cache bool `json:"cache,omitempty"`

	// the maximum number of memory (measured in bytes) that the query is allowed to use. If set, then the query will fail
	// with error "resource limit exceeded" in case it allocates too much memory. A value of 0 indicates that there is no memory limit.
	MemoryLimit int64 `json:"memoryLimit,omitempty"`

	// The time-to-live for the cursor (in seconds). The cursor will be removed on the server automatically after the specified
	// amount of time. This is useful to ensure garbage collection of cursors that are not fully fetched by clients.
	// If not set, a server-defined value will be used.
	TTL float64 `json:"ttl,omitempty"`
}
```

--------------------------------

### BackupCreate

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Creates a new backup and returns its identifier.

```APIDOC
## BackupCreate

### Description
Creates a new backup and returns its id.

### Method
Go Method: BackupCreate(ctx context.Context, opt *BackupCreateOptions) (BackupResponse, error)
```

--------------------------------

### Define Foxx Test Options

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Configuration options for running tests on Foxx services.

```go
type FoxxTestOptions struct {
	FoxxDeploymentOptions
	Reporter  *string `json:"reporter,omitempty"`
	Idiomatic *bool   `json:"idiomatic,omitempty"`
	Filter    *string `json:"filter,omitempty"`
}
```

--------------------------------

### DatabaseInventory Structure

Source: https://pkg.go.dev/github.com/arangodb/go-driver/v2/arangodb

Contains the full inventory of a database, including collections, views, and server state.

```go
type DatabaseInventory struct {
	Info        DatabaseInfo          `json:"properties,omitempty"`
	Collections []InventoryCollection `json:"collections,omitempty"`
	Views       []InventoryView       `json:"views,omitempty"`
	State       ServerStatus          `json:"state,omitempty"`
	Tick        string                `json:"tick,omitempty"`
}
```
Tokens:
Raw