DatabaseApiClient Class |
A client for interacting with ArangoDB Databases endpoints,
implementing IDatabaseApiClient.
Inheritance HierarchyNamespace: ArangoDBNetStandard.DatabaseApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe DatabaseApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DatabaseApiClient(IApiClientTransport) |
Creates an instance of DatabaseApiClient
using the provided transport layer and the default JSON serialization.
|
| DatabaseApiClient(IApiClientTransport, IApiClientSerialization) |
Creates an instance of DatabaseApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteDatabaseAsync |
Delete a database. Dropping a database is only possible from within the _system database.
The _system database itself cannot be dropped.
DELETE /_api/database/{database-name}
|
 | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetCurrentDatabaseInfoAsync |
Retrieves information about the current database.
|
| GetDatabasesAsync |
Retrieves the list of all existing databases.
(Only possible from within the _system database)
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUserDatabasesAsync |
Retrieves the list of all databases the current user can access.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PostDatabaseAsync |
Creates a new database.
(Only possible from within the _system database)
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _client |
The transport client used to communicate with the ArangoDB host.
|
| _databaseApiPath |
The root path of the API.
|
See Also