Module: Arango::Database::SystemCollections

Defined in:
lib/arango/database/system_collections.rb

Overview

Arango Database SystemCollections

Instance Method Summary collapse

Instance Method Details

#all_system_collections(exclude_system: true) ⇒ Array<Arango::DocumentCollection>

Retrieves all collections from the database.

Parameters:

  • exclude_system (Boolean) (defaults to: true) —

    Optional, default true, exclude system collections.

Returns:



9
10
11
 
# File 'lib/arango/database/system_collections.rb', line 9

def all_system_collections(exclude_system: true)
  Arango::DocumentCollection.all(exclude_system: exclude_system, database: self)
end

#batch_all_system_collections(exclude_system: true) ⇒ Object 



12
13
14
 
# File 'lib/arango/database/system_collections.rb', line 12

def batch_all_system_collections(exclude_system: true)
  Arango::DocumentCollection.batch_all(exclude_system: exclude_system, database: self)
end

#batch_create_edge_system_collection(name) ⇒ Object 



33
34
35
 
# File 'lib/arango/database/system_collections.rb', line 33

def batch_create_edge_system_collection(name)
  Arango::EdgeCollection.new(name, type: :edge, database: self).batch_create
end

#batch_create_system_collection(name, type: :document, is_system: false) ⇒ Object 



23
24
25
 
# File 'lib/arango/database/system_collections.rb', line 23

def batch_create_system_collection(name, type: :document, is_system: false)
  Arango::DocumentCollection.new(name, type: type, database: self, is_system: is_system).batch_create
end

#batch_drop_system_collection(name) ⇒ Object Also known as: batch_delete_system_collection, batch_destroy_system_collection 



82
83
84
 
# File 'lib/arango/database/system_collections.rb', line 82

def batch_drop_system_collection(name)
  Arango::DocumentCollection.batch_drop(name, database: self)
end

#batch_get_system_collection(name) ⇒ Object Also known as: batch_fetch_system_collection, batch_retrieve_system_collection 



43
44
45
 
# File 'lib/arango/database/system_collections.rb', line 43

def batch_get_system_collection(name)
  Arango::DocumentCollection.batch_get(name, database: self)
end

#batch_list_system_collections(exclude_system: true) ⇒ Object 



72
73
74
 
# File 'lib/arango/database/system_collections.rb', line 72

def batch_list_system_collections(exclude_system: true)
  Arango::DocumentCollection.batch_list(exclude_system: exclude_system, database: self)
end

#batch_system_collection_exists?(name, exclude_system: true) ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/arango/database/system_collections.rb', line 96

def batch_system_collection_exists?(name, exclude_system: true)
  Arango::DocumentCollection.batch_exists?(name, database: self, exclude_system: exclude_system)
end

#create_edge_system_collection(name) ⇒ Arango::DocumentCollection

Creates a new edge collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



30
31
32
 
# File 'lib/arango/database/system_collections.rb', line 30

def create_edge_system_collection(name)
  Arango::EdgeCollection.new(name, type: :edge, database: self).create
end

#create_system_collection(name, type: :document, is_system: false) ⇒ Arango::DocumentCollection

Creates a new collection.

Parameters:

  • name (String) —

    The name of the collection.

  • type (Symbol) (defaults to: :document) —

    One of :document or :edge, the collection type, optional, default: :document.

Returns:



20
21
22
 
# File 'lib/arango/database/system_collections.rb', line 20

def create_system_collection(name, type: :document, is_system: false)
  Arango::DocumentCollection.new(name, type: type, database: self, is_system: is_system).create
end

#drop_system_collection(name) ⇒ Object Also known as: delete_system_collection, destroy_system_collection

Removes a collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:

  • nil



79
80
81
 
# File 'lib/arango/database/system_collections.rb', line 79

def drop_system_collection(name)
  Arango::DocumentCollection.drop(name, database: self)
end

#get_system_collection(name) ⇒ Arango::Database Also known as: fetch_system_collection, retrieve_system_collection

Get collection from the database.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



40
41
42
 
# File 'lib/arango/database/system_collections.rb', line 40

def get_system_collection(name)
  Arango::DocumentCollection.get(name, database: self)
end

#list_system_collections(exclude_system: true) ⇒ Array<String>

Retrieves a list of all collections.

Parameters:

  • exclude_system (Boolean) (defaults to: true) —

    Optional, default true, exclude system collections.

Returns:

  • (Array<String>) —

    List of collection names.



69
70
71
 
# File 'lib/arango/database/system_collections.rb', line 69

def list_system_collections(exclude_system: true)
  Arango::DocumentCollection.list(exclude_system: exclude_system, database: self)
end

#new_edge_system_collection(name) ⇒ Arango::DocumentCollection

Instantiates a new edge collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



62
63
64
 
# File 'lib/arango/database/system_collections.rb', line 62

def new_edge_system_collection(name)
  Arango::DocumentCollection.new(name, type: :edge, database: self)
end

#new_system_collection(name, type: :document) ⇒ Arango::DocumentCollection

Instantiates a new collection.

Parameters:

  • name (String) —

    The name of the collection.

  • type (Symbol) (defaults to: :document) —

    One of :document or :edge, the collection type, optional, default: :document.

Returns:



55
56
57
 
# File 'lib/arango/database/system_collections.rb', line 55

def new_system_collection(name, type: :document)
  Arango::DocumentCollection.new(name, type: type, database: self)
end

#system_collection_exists?(name, exclude_system: true) ⇒ Boolean

Check if collection exists.

Parameters:

  • name (String) —

    Name of the collection

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/arango/database/system_collections.rb', line 93

def system_collection_exists?(name, exclude_system: true)
  Arango::DocumentCollection.exists?(name, database: self, exclude_system: exclude_system)
end