_id
stringlengths
2
7
text
stringlengths
6
2.61k
title
stringclasses
1 value
c5700
// newDatabase creates a new Database implementation.
c5701
// Info fetches information about the database.
c5702
// Remove removes the entire database. // If the database does not exist, a NotFoundError is returned.
c5703
// Query performs an AQL query, returning a cursor used to iterate over the returned documents.
c5704
// ValidateQuery validates an AQL query. // When the query is valid, nil returned, otherwise an error is returned. // The query is not executed.
c5705
// Database opens a connection to an existing database. // If no database with given name exists, an NotFoundError is returned.
c5706
// AccessibleDatabases returns a list of all databases that can be accessed by the authenticated user.
c5707
// listDatabases returns a list of databases using a GET to the given path.
c5708
// CreateDatabase creates a new database with given name and opens a connection to it. // If the a database with given name already exists, a DuplicateError is returned.
c5709
// Cluster provides access to cluster wide specific operations. // To use this interface, an ArangoDB cluster is required. // If this method is a called without a cluster, a PreconditionFailed error is returned.
c5710
// CreateBatch creates a "batch" to prevent WAL file removal and to take a snapshot
c5711
// Extend the lifetime of an existing batch on the server
c5712
// Delete an existing dump batch
c5713
// NewConnection creates a new Velocystream connection based on the given configuration settings.
c5714
// newVSTConnection creates a new Velocystream connection for a single endpoint and the remainder of the given configuration settings.
c5715
// closes the response channel if needed.
c5716
// addChunk adds the given chunks to the list of chunks of the message. // If the given chunk is the first chunk, the expected number of chunks is recorded.
c5717
// assemble tries to assemble the message data from all chunks. // If not all chunks are available yet, nothing is done and false // is returned. // If all chunks are available, the Data field is build and set and true is returned.
c5718
// IsReady returns true if the IsReady flag of all collections is set.
c5719
// PlanVersion returns the plan version of the first collection in the given inventory.
c5720
// CollectionByName returns the InventoryCollection with given name. // Return false if not found.
c5721
// ViewByName returns the InventoryView with given name. // Return false if not found.
c5722
// IndexByFieldsAndType returns the InventoryIndex with given fields & type. // Return false if not found.
c5723
// FieldsEqual returns true when the given fields list equals the // Fields list in the InventoryIndex. // The order of fields is irrelevant.
c5724
// stringSliceEqualsIgnoreOrder returns true when the given lists contain the same elements. // The order of elements is irrelevant.
c5725
// Size returns the number of messages in this store.
c5726
// Get returns the message with given id, or nil if not found
c5727
// Add adds a new message to the store with given ID. // If the ID is not unique this function will panic.
c5728
// Remove removes the message with given ID from the store.
c5729
// ForEach calls the given function for each message in the store.
c5730
// ReadDocument reads a single document with given key from the collection. // The document data is stored into result, the document meta data is returned. // If no document exists with given key, a NotFoundError is returned.
c5731
// UpdateDocument updates a single document with given key in the collection. // The document meta data is returned. // To return the NEW document, prepare a context with `WithReturnNew`. // To return the OLD document, prepare a context with `WithReturnOld`. // To wait until document has been synced to disk, prepare a context with `WithWaitForSync`. // If no document exists with given key, a NotFoundError is returned.
c5732
// getKeyFromDocument looks for a `_key` document in the given document and returns it.
c5733
// newAuthenticatedConnection creates a Connection that applies the given connection on the given underlying connection.
c5734
// prepare calls Authentication.Prepare if needed.
c5735
// NewTransport creates a new Transport for given address & tls settings.
c5736
// CloseIdleConnections closes all connections which are closed or have been idle for more than the configured idle timeout.
c5737
// CloseAllConnections closes all connections.
c5738
// SetOnConnectionCreated stores a callback function that is called every time a new connection has been created.
c5739
// getConnection returns the first available connection, or when no such connection is available, // is created a new connection.
c5740
// getAvailableConnection returns the first available connection. // If no such connection is available, nil is returned.
c5741
// createConnection creates a new connection.
c5742
// cleanup keeps removing idle connections
c5743
// Do performs a given request, returning its response. // In case of a termporary failure, the request is retried until // the deadline is exceeded.
c5744
// agencyConnectionFailureBackoff returns a backoff delay for cases where all // agents responded with a non-fatal error.
c5745
// increaseDelay returns an delay, increased from an old delay with a given // factor, limited to given min & max.
c5746
// Properties fetches extended information about the view.
c5747
// SetProperties changes properties of the view.
c5748
// NewConnection creates a new cluster connection to a cluster of servers. // The given connections are existing connections to each of the servers.
c5749
// getCurrentServer returns the currently used server.
c5750
// getSpecificServer returns the server with the given endpoint.
c5751
// getNextServer changes the currently used server and returns the new server.
c5752
// newCollection creates a new Collection implementation.
c5753
// UnLoad the collection from memory.
c5754
// UnmarshalJSON loads CollectionProperties from json
c5755
// UnmarshalJSON loads SetCollectionPropertiesOptions from json
c5756
// newHTTPConnection creates a new HTTP connection for a single endpoint and the remainder of the given configuration settings.
c5757
// readBody reads the body of the given response into a byte slice.
c5758
// parseResponseArray parses an array response in the given response
c5759
// newGraph creates a new Graph implementation.
c5760
// Remove removes the entire graph. // If the graph does not exist, a NotFoundError is returned.
c5761
// readChunkVST1_1 reads an entire chunk from the given reader in VST 1.1 format.
c5762
// WriteToVST1_1 write the chunk to the given writer in VST 1.0 format. // An error is returned when less than the entire chunk was written.
c5763
// Collection opens a connection to an existing collection within the database. // If no collection with given name exists, an NotFoundError is returned.
c5764
// Collections returns a list of all collections in the database.
c5765
// CreateCollection creates a new collection with given name and options, and opens a connection to it. // If a collection with given name already exists within the database, a DuplicateError is returned.
c5766
// newResponse builds a vstResponse from given message.
c5767
// ReplaceDocument replaces a single document with given key in the collection with the document given in the document argument. // The document meta data is returned. // To return the NEW document, prepare a context with `WithReturnNew`. // To return the OLD document, prepare a context with `WithReturnOld`. // To wait until document has been synced to disk, prepare a context with `WithWaitForSync`. // If no document exists with given key, a NotFoundError is returned.
c5768
// ReplaceDocuments replaces multiple documents with given keys in the collection with the documents given in the documents argument. // The replacements are loaded from the given documents slice, the documents meta data are returned. // To return the NEW documents, prepare a context with `WithReturnNew` with a slice of documents. // To return the OLD documents, prepare a context with `WithReturnOld` with a slice of documents. // To wait until documents has been synced to disk, prepare a context with `WithWaitForSync`. // If no document exists with a given key, a NotFoundError is returned at its errors index.
c5769
// RemoveDocument removes a single document with given key from the collection. // The document meta data is returned. // To return the OLD document, prepare a context with `WithReturnOld`. // To wait until removal has been synced to disk, prepare a context with `WithWaitForSync`. // If no document exists with given key, a NotFoundError is returned.
c5770
// View opens a connection to an existing view within the database. // If no collection with given name exists, an NotFoundError is returned.
c5771
// ViewExists returns true if a view with given name exists within the database.
c5772
// Views returns a list of all views in the database.
c5773
// CreateArangoSearchView creates a new view of type ArangoSearch, // with given name and options, and opens a connection to it. // If a view with given name already exists within the database, a ConflictError is returned.
c5774
// VertexCollection opens a connection to an existing edge-collection within the graph. // If no edge-collection with given name exists, an NotFoundError is returned.
c5775
// VertexCollectionExists returns true if an edge-collection with given name exists within the graph.
c5776
// VertexCollections returns all edge collections of this graph
c5777
// Endpoint returns the endpoint that handled the request.
c5778
// getSlice reads the slice from the response if needed.
c5779
// String creates a string representation of the given VersionInfo.
c5780
// buildChunks splits a message consisting of 1 or more parts into chunks.
c5781
// NewClient creates a new Client based on the given config setting.
c5782
// SynchronizeEndpoints fetches all endpoints from an ArangoDB cluster and updates the // connection to use those endpoints. // When this client is connected to a single server, nothing happens. // When this client is connected to a cluster of servers, the connection will be updated to reflect // the layout of the cluster.
c5783
// autoSynchronizeEndpoints performs automatic endpoint synchronization.
c5784
// IfEmpty adds an empty check on the given key to the given condition // and returns the updated condition.
c5785
// toMap convert the given condition to a map suitable for writeTransaction.
c5786
// IfEmpty adds an "is empty" check on the given key to the given condition // and returns the updated condition.
c5787
// IfIsArray adds an "is-array" check on the given key to the given condition // and returns the updated condition.
c5788
// IfEqualTo adds an "value equals oldValue" check to given old value on the // given key to the given condition and returns the updated condition.
c5789
// newVertexCollection creates a new Vertex Collection implementation.
c5790
// Revision fetches the revision ID of the collection. // The revision ID is a server-generated string that clients can use to check whether data // in a collection has changed since the last revision check.
c5791
// BasicAuthentication creates an authentication implementation based on the given username & password.
c5792
// JWTAuthentication creates a JWT token authentication implementation based on the given username & password.
c5793
// Get returns a configuration property of the authentication. // Supported properties depend on type of authentication.
c5794
// Major returns the major part of the version // E.g. "3.1.7" -> 3
c5795
// Minor returns the minor part of the version. // E.g. "3.1.7" -> 1
c5796
// Sub returns the sub part of the version. // E.g. "3.1.7" -> "7"
c5797
// SubInt returns the sub part of the version as integer. // The bool return value indicates if the sub part is indeed a number. // E.g. "3.1.7" -> 7, true // E.g. "3.1.foo" -> 0, false
c5798
// Keys returns the keys of all elements.
c5799
// Revs returns the revisions of all elements.