ArangoDB-PHP API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • triagens
    • ArangoDb

Classes

  • AdminHandler
  • AqlUserFunction
  • Autoloader
  • Batch
  • BatchPart
  • BindVars
  • Collection
  • CollectionHandler
  • Connection
  • ConnectionOptions
  • Cursor
  • Database
  • DefaultValues
  • Document
  • DocumentHandler
  • Edge
  • EdgeDefinition
  • EdgeHandler
  • Endpoint
  • Export
  • ExportCursor
  • Graph
  • GraphHandler
  • Handler
  • HttpHelper
  • HttpResponse
  • QueryCacheHandler
  • QueryHandler
  • Statement
  • TraceRequest
  • TraceResponse
  • Transaction
  • Traversal
  • UpdatePolicy
  • UrlHelper
  • Urls
  • User
  • UserHandler
  • ValueValidator
  • Vertex
  • VertexHandler

Exceptions

  • ClientException
  • ConnectException
  • Exception
  • ServerException

Class Database

A class for managing ArangoDB Databases

This class provides functions to manage Databases through ArangoDB's Database API

Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 1.4
Link: https://docs.arangodb.com/HTTP/Database/index.html
Located at Database.php

Methods summary

public static array
# create( triagens\ArangoDb\Connection $connection, string $name )

creates a database

creates a database

This creates a new database

Parameters

$connection
  • the connection to be used
$name
  • the database specification, for example 'myDatabase'

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception
triagens\ArangoDb\ClientException

Link

https://docs.arangodb.com/HTTP/Database/index.html
public static array
# delete( triagens\ArangoDb\Connection $connection, string $name )

Deletes a database

Deletes a database

This will delete an existing database.

Parameters

$connection
  • the connection to be used
$name
  • the database specification, for example 'myDatabase'

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception
triagens\ArangoDb\ClientException

Link

https://docs.arangodb.com/HTTP/Database/index.html
public static array
# listDatabases( triagens\ArangoDb\Connection $connection )

List databases

List databases

This will list the databases that exist on the server

Parameters

$connection
  • the connection to be used

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception
triagens\ArangoDb\ClientException

Link

https://docs.arangodb.com/HTTP/Database/index.html
public static array
# databases( triagens\ArangoDb\Connection $connection )

List databases

List databases

This will list the databases that exist on the server

Parameters

$connection
  • the connection to be used

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception
triagens\ArangoDb\ClientException

Link

https://docs.arangodb.com/HTTP/Database/index.html
public static array
# listUserDatabases( triagens\ArangoDb\Connection $connection )

List user databases

List user databases

Retrieves the list of all databases the current user can access without specifying a different username or password.

Parameters

$connection
  • the connection to be used

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception
triagens\ArangoDb\ClientException

Link

https://docs.arangodb.com/HTTP/Database/index.html
public static array
# getInfo( triagens\ArangoDb\Connection $connection )

Retrieves information about the current database

Retrieves information about the current database

This will get information about the currently used database from the server

Parameters

$connection
  • the connection to be used

Returns

array
$responseArray - The response array.

Throws

triagens\ArangoDb\Exception
triagens\ArangoDb\ClientException

Link

https://docs.arangodb.com/HTTP/Database/index.html

Constants summary

string ENTRY_DATABASE_NAME

Databases index

Databases index

# 'name'
string ENTRY_DATABASE_USERS

Users index

Users index

# 'users'
ArangoDB-PHP API Documentation API documentation generated by ApiGen