Module: Arango::Server::Databases

Included in:
Arango::Server
Defined in:
lib/arango/server/databases.rb

Overview

Arango Server Databases

Instance Method Summary collapse

Instance Method Details

#all_databases ⇒ Array<Arango::Database>

Retrieves all databases.

Returns:



8
9
10
 
# File 'lib/arango/server/databases.rb', line 8

def all_databases
  Arango::Database.all(server: self)
end

#all_user_databases ⇒ Array<Arango::Database>

Retrieves all databases the current user can access.

Returns:



14
15
16
 
# File 'lib/arango/server/databases.rb', line 14

def all_user_databases
  Arango::Database.all_user_databases(server: self)
end

#create_database(name:) ⇒ Arango::Database

Creates a new database.

Parameters:

  • name (String) —

    The name of the database

Returns:



33
34
35
 
# File 'lib/arango/server/databases.rb', line 33

def create_database(name:)
  Arango::Database.new(name: name, server: self).create
end

#database_exists?(name:) ⇒ Boolean

Check if database exists.

Parameters:

  • name (String) —

    Name of the database.

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/arango/server/databases.rb', line 63

def database_exists?(name:)
  Arango::Database.exists?(name: name, server: self)
end

#delete_database(name:) ⇒ Object

Removes a database.

Parameters:

  • name (String) —

    The name of the database

Returns:

  • nil



47
48
49
 
# File 'lib/arango/server/databases.rb', line 47

def delete_database(name:)
  Arango::Database.delete(name: name, server: self)
end

#get_database(name:) ⇒ Arango::Database

Get database from server.

Parameters:

  • name (String) —

    The name of the database

Returns:



54
55
56
57
58
 
# File 'lib/arango/server/databases.rb', line 54

def get_database(name:)
  db = Arango::Database.get(name: name, server: self)
  self.current_database = db unless self.current_database
  db
end

#list_databases ⇒ Array<String>

Retrieves a list of all databases.

Returns:

  • (Array<String>) —

    List of database names.



20
21
22
 
# File 'lib/arango/server/databases.rb', line 20

def list_databases
  Arango::Database.list(server: self)
end

#list_user_databases ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    List of database names.



26
27
28
 
# File 'lib/arango/server/databases.rb', line 26

def list_user_databases
  Arango::Database.list_user_databases(server: self)
end

#new_database(name:) ⇒ Arango::Database

Instantiates a new database, but does not store it on th server.

Parameters:

  • name (String) —

    The name of the database

Returns:



40
41
42
 
# File 'lib/arango/server/databases.rb', line 40

def new_database(name:)
  Arango::Database.new(name: name, server: self)
end