Module: Arango::Database::DocumentCollections

Included in:
Arango::Database
Defined in:
lib/arango/database/document_collections.rb

Overview

Arango Database DocumentCollections

Instance Method Summary collapse

Instance Method Details

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

Retrieves all document 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/document_collections.rb', line 9

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

#batch_all_document_collections(exclude_system: true) ⇒ Object 



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

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

#batch_create_document_collection(name:, is_system: false) ⇒ Object 



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

def batch_create_document_collection(name:, is_system: false)
  Arango::DocumentCollection::Base.new(name: name, database: self, is_system: is_system).batch_create
end

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

Returns:

  • (Boolean) 


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

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

#batch_drop_document_collection(name:) ⇒ Object Also known as: batch_delete_document_collection, batch_destroy_document_collection 



65
66
67
 
# File 'lib/arango/database/document_collections.rb', line 65

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

#batch_get_document_collection(name:) ⇒ Object Also known as: batch_fetch_document_collection, batch_retrieve_document_collection 



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

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

#batch_list_document_collections(exclude_system: true) ⇒ Object 



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

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

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

Creates a new document collection.

Parameters:

  • name (String) —

    The name of the collection.

  • is_system (Boolean) (defaults to: false) —

    set true to create a system collection, defaults to false

Returns:



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

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

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

Check if document collection exists.

Parameters:

  • name (String) —

    Name of the collection

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/arango/database/document_collections.rb', line 76

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

#drop_document_collection(name:) ⇒ Object Also known as: delete_document_collection, destroy_document_collection

Removes a document collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:

  • nil



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

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

#get_document_collection(name:) ⇒ Arango::Database Also known as: fetch_document_collection, retrieve_document_collection

Get document collection from the database.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



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

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

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

Retrieves a list of document collections.

Parameters:

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

    Optional, default true, exclude system collections.

Returns:

  • (Array<String>) —

    List of collection names.



52
53
54
 
# File 'lib/arango/database/document_collections.rb', line 52

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

#new_document_collection(name:, type: :document) ⇒ Arango::DocumentCollection::Base

Instantiates a new document 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:



45
46
47
 
# File 'lib/arango/database/document_collections.rb', line 45

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