Liking cljdoc? Tell your friends :D

clarango.database


collection-exists?clj

(collection-exists? collection-name & args)

Returns true if a collection with the given name exists, otherwise returns false.

Can be called without arguments. In that case the default database will be used. Optionally you can pass a database name as second argument.

Returns true if a collection with the given name exists, otherwise returns false.

Can be called without arguments. In that case the default database will be used.
Optionally you can pass a database name as second argument.
sourceraw docstring

createclj

(create database-name users)

Creates a new database.

First argument: the name of the new database Second argument: a vector specifying users to initially create for the new database; can be empty; in this case a default user 'root' with an empty password will be created; if not empty, it must contain user objects which may contain the following options: - username: the user name as a string - passwd: the user password as a string; if omitted, an empty password will be set - active: boolean flag indicating whether the user accout should be actived or not; default is true; - extra: an optional map of user information that will be saved, but not interpreted by ArangoDB

Creates a new database.

First argument: the name of the new database
Second argument: a vector specifying users to initially create for the new database; 
  can be empty; in this case a default user 'root' with an empty password will be created;
  if not empty, it must contain user objects which may contain the following options:
    - username: the user name as a string
    - passwd: the user password as a string; if omitted, an empty password will be set
    - active: boolean flag indicating whether the user accout should be actived or not; default is true;
    - extra: an optional map of user information that will be saved, but not interpreted by ArangoDB
sourceraw docstring

database-exists?clj

(database-exists? database-name)

Returns true if a database with the given name exists, otherwise returns false.

Returns true if a database with the given name exists, otherwise returns false.
sourceraw docstring

deleteclj

(delete database-name)

Deletes a database.

Expects the database name of the database to be dropped as argument.

Deletes a database.

Expects the database name of the database to be dropped as argument.
sourceraw docstring

get-all-graphsclj

(get-all-graphs & args)

Gets a list of all existing graphs within the database.

Can be called without arguments. In that case the default database will be used. Optionally you can pass a database name as argument.

Gets a list of all existing graphs within the database.

Can be called without arguments. In that case the default database will be used.
Optionally you can pass a database name as argument.
sourceraw docstring

get-collection-info-listclj

(get-collection-info-list & args)

Returns information about all collections in a database as a list.

Can be called without arguments. In that case the default database will be used. Optionally you can pass a database and a map with options as arguments. Possible options in the options map are: {'excludeSystem' true/false}

  • excludeSystem meaning whether or not the system collections should be excluded from the result.
Returns information about all collections in a database as a list.

Can be called without arguments. In that case the default database will be used.
Optionally you can pass a database and a map with options as arguments.
Possible options in the options map are:
{'excludeSystem' true/false}
- excludeSystem meaning whether or not the system collections should be excluded from the result.
sourceraw docstring

get-info-currentclj

(get-info-current)

Returns information about the current database.

Returns information about the current database.
sourceraw docstring

get-info-listclj

(get-info-list)

Returns a list of all existing databases.

Returns a list of all existing databases.
sourceraw docstring

get-info-userclj

(get-info-user)

Returns a list of all databases the current user can access.

Note: this might not work under Windows.

Returns a list of all databases the current user can access.

Note: this might not work under Windows.
sourceraw docstring

graph-exists?clj

(graph-exists? graph-name & args)

Returns true if a graph with the given name exists, otherwise returns false.

Can be called without arguments. In that case the default database will be used. Optionally you can pass a database name as second argument.

Returns true if a graph with the given name exists, otherwise returns false.

Can be called without arguments. In that case the default database will be used.
Optionally you can pass a database name as second argument.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close