_id
stringlengths
2
7
text
stringlengths
6
2.61k
title
stringclasses
1 value
c5600
// Error returns the error message of an ArangoError.
c5601
// Timeout returns true when the given error is a timeout error.
c5602
// Temporary returns true when the given error is a temporary error.
c5603
// newArangoError creates a new ArangoError with given values.
c5604
// IsArangoError returns true when the given error is an ArangoError.
c5605
// IsArangoErrorWithCode returns true when the given error is an ArangoError and its Code field is equal to the given code.
c5606
// IsArangoErrorWithErrorNum returns true when the given error is an ArangoError and its ErrorNum field is equal to one of the given numbers.
c5607
// IsNoLeaderOrOngoing return true if the given error is an ArangoError with code 503 and error number 1496 or 1495
c5608
// IsInvalidArgument returns true if the given error is an InvalidArgumentError.
c5609
// IsNoMoreDocuments returns true if the given error is an NoMoreDocumentsError.
c5610
// IsCanceled returns true if the given error is the result on a cancelled context.
c5611
// IsTimeout returns true if the given error is the result on a deadline that has been exceeded.
c5612
// isCausedBy returns true if the given error returns true on the given predicate, // unwrapping various standard library error wrappers.
c5613
// FirstNonNil returns the first error in the slice that is not nil. // If all errors in the slice are nil, nil is returned.
c5614
// dial opens a new connection to the server on the given address.
c5615
// Close the connection to the server
c5616
// sendChunk sends a single chunk to the server.
c5617
// readChunkLoop reads chunks from the connection until it is closed.
c5618
// processChunk adds the given chunk to its message and notifies the listener // when the message is complete.
c5619
// IsIdle returns true when the last activity was more than the given timeout ago.
c5620
// indexStringToType converts a string representation of an index to IndexType
c5621
// newIndex creates a new Index implementation.
c5622
// Name returns the name of the index.
c5623
// Remove removes the entire index. // If the index does not exist, a NotFoundError is returned.
c5624
// NewLock creates a new lock on the given key.
c5625
// Lock tries to lock the lock. // If it is not possible to lock, an error is returned. // If the lock is already held by me, an error is returned.
c5626
// Unlock tries to unlock the lock. // If it is not possible to unlock, an error is returned. // If the lock is not held by me, an error is returned.
c5627
// IsLocked return true if the lock is held by me.
c5628
// renewLock keeps renewing the lock until the given context is canceled.
c5629
// User opens a connection to an existing user. // If no user with given name exists, an NotFoundError is returned.
c5630
// UserExists returns true if a database with given name exists.
c5631
// Users returns a list of all users found by the client.
c5632
// CreateUser creates a new user with given name and opens a connection to it. // If a user with given name already exists, a DuplicateError is returned.
c5633
// newEdgeCollection creates a new EdgeCollection implementation.
c5634
// rawCollection returns a standard document implementation of Collection // for this edge collection.
c5635
// Statistics returns the number of documents and additional statistical information about the collection.
c5636
// SetBody sets the content of the request. // The protocol of the connection determines what kinds of marshalling is taking place. // When multiple bodies are given, they are merged, with fields in the first document prevailing.
c5637
// requestType converts method to request type.
c5638
// newCursor creates a new Cursor implementation.
c5639
// Name returns the name of the collection.
c5640
// Close deletes the cursor and frees the resources associated with it.
c5641
// ReadDocument reads the next document from the cursor. // The document data is stored into result, the document meta data is returned. // If the cursor has no more documents, a NoMoreDocuments error is returned.
c5642
// SetQuery sets a single query argument of the request. // Any existing query argument with the same key is overwritten.
c5643
// SetHeader sets a single header arguments of the request. // Any existing header argument with the same key is overwritten.
c5644
// WithAllowNoLeader is used to configure a context to make AreAgentsHealthy // accept the situation where it finds 0 leaders.
c5645
// hasAllowNoLeader returns true when the given context was // prepared with WithAllowNoLeader.
c5646
// AreAgentsHealthy performs a health check on all given agents. // Of the given agents, 1 must respond as leader and all others must redirect to the leader. // The function returns nil when all agents are healthy or an error when something is wrong.
c5647
// IsSameEndpoint returns true when the 2 given endpoints // refer to the same server.
c5648
// Indexes returns a list of all indexes in the collection.
c5649
// newUser creates a new User implementation.
c5650
// Remove removes the entire user. // If the user does not exist, a NotFoundError is returned.
c5651
// Update updates individual properties of the user. // If the user does not exist, a NotFoundError is returned.
c5652
// AccessibleDatabases returns a list of all databases that can be accessed by this user.
c5653
// SetDatabaseAccess sets the access this user has to the given database. // Pass a `nil` database to set the default access this user has to any new database. // This function requires ArangoDB 3.2 and up for access value `GrantReadOnly`.
c5654
// GetDatabaseAccess gets the access rights for this user to the given database. // Pass a `nil` database to get the default access this user has to any new database. // This function requires ArangoDB 3.2 and up.
c5655
// SetCollectionAccess sets the access this user has to a collection. // If you pass a `Collection`, it will set access for that collection. // If you pass a `Database`, it will set the default collection access for that database. // If you pass `nil`, it will set the default collection access for the default database....
c5656
// GetCollectionAccess gets the access rights for this user to the given collection. // If you pass a `Collection`, it will get access for that collection. // If you pass a `Database`, it will get the default collection access for that database. // If you pass `nil`, it will get the default collection access for the de...
c5657
// RemoveCollectionAccess removes the access this user has to a collection. // If you pass a `Collection`, it will removes access for that collection. // If you pass a `Database`, it will removes the default collection access for that database. // If you pass `nil`, it will removes the default collection access for the...
c5658
// getDatabaseAndCollectionName returns database-name, collection-name from given access target.
c5659
// WithQueryCount is used to configure a context that will set the Count of a query request, // If value is not given it defaults to true.
c5660
// WithQueryBatchSize is used to configure a context that will set the BatchSize of a query request,
c5661
// WithQueryCache is used to configure a context that will set the Cache of a query request, // If value is not given it defaults to true.
c5662
// WithQueryMemoryLimit is used to configure a context that will set the MemoryList of a query request,
c5663
// WithQueryTTL is used to configure a context that will set the TTL of a query request,
c5664
// WithQuerySatelliteSyncWait sets the satelliteSyncWait query value on the query cursor request
c5665
// WithQueryFullCount is used to configure whether the query returns the full count of results // before the last LIMIT statement
c5666
// applyContextSettings fills fields in the queryRequest from the given context.
c5667
// Graph opens a connection to an existing graph within the database. // If no graph with given name exists, an NotFoundError is returned.
c5668
// Graphs returns a list of all graphs in the database.
c5669
// CreateGraph creates a new graph with given name and options, and opens a connection to it. // If a graph with given name already exists within the database, a DuplicateError is returned.
c5670
// Clone creates a new request containing the same data as this request
c5671
// SetBody sets the content of the request. // The protocol of the connection determines what kinds of marshalling is taking place.
c5672
// Contains returns true if the given protocol is contained in the given set, false otherwise.
c5673
// ContainsAny returns true if any of the given protocols is contained in the given set, false otherwise.
c5674
// Shutdown a specific server, optionally removing it from its cluster.
c5675
// EdgeCollection opens a connection to an existing edge-collection within the graph. // If no edge-collection with given name exists, an NotFoundError is returned.
c5676
// EdgeCollectionExists returns true if an edge-collection with given name exists within the graph.
c5677
// EdgeCollections returns all edge collections of this graph
c5678
// newView creates a new View implementation.
c5679
// ArangoSearchView returns this view as an ArangoSearch view. // When the type of the view is not ArangoSearch, an error is returned.
c5680
// Remove removes the entire view. // If the view does not exist, a NotFoundError is returned.
c5681
// newCluster creates a new Cluster implementation.
c5682
// MoveShard moves a single shard of the given collection from server `fromServer` to // server `toServer`.
c5683
// CleanOutServer triggers activities to clean out a DBServers.
c5684
// IsCleanedOut checks if the dbserver with given ID has been cleaned out.
c5685
// NumberOfServers returns the number of coordinator & dbservers in a clusters and the // ID's of cleaned out servers.
c5686
// RemoveServer is a low-level option to remove a server from a cluster. // This function is suitable for servers of type coordinator or dbserver. // The use of `ClientServerAdmin.Shutdown` is highly recommended above this function.
c5687
// UnmarshalJSON loads InventoryCollectionParameters from json
c5688
// MarshalJSON marshals InventoryCollectionParameters to arangodb json representation
c5689
// UnmarshalJSON marshals InventoryCollectionParameters to arangodb json representation
c5690
// NewAgency creates an Agency accessor for the given connection. // The connection must contain the endpoints of one or more agents, and only agents.
c5691
// ReadKey reads the value of a given key in the agency.
c5692
// WriteKeyIfEmpty writes the given value with the given key only if the key was empty before.
c5693
// WriteKeyIfEqualTo writes the given new value with the given key only if the existing value for that key equals // to the given old value.
c5694
// write writes the given value with the given key only if the given condition is fullfilled.
c5695
// RemoveKeyIfEqualTo removes the given key only if the existing value for that key equals // to the given old value.
c5696
// Register a URL to receive notification callbacks when the value of the given key changes
c5697
// CreateArangodJwtAuthorizationHeader calculates a JWT authorization header, for authorization // of a request to an arangod server, based on the given secret. // If the secret is empty, nothing is done. // Use the result of this function as input for driver.RawAuthentication.
c5698
// decodeObjectFields decodes fields from the given body into a objValue of kind struct.
c5699
// decodeMapFields decodes fields from the given body into a mapValue of kind map.