Module: Arango::Database::DocumentCollections

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

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:



7
8
9
 
# File 'lib/arango/database/document_collections.rb', line 7

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 



10
11
12
 
# File 'lib/arango/database/document_collections.rb', line 10

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 



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

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) 


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

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 



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

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 



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

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

#batch_list_document_collections(exclude_system: true) ⇒ Object 



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

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

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

Creates a new document collection.

Parameters:

  • name (String) —

    The name of the collection.

  • type (Symbol) —

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

Returns:



18
19
20
 
# File 'lib/arango/database/document_collections.rb', line 18

def create_document_collection(name:, 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) 


74
75
76
 
# File 'lib/arango/database/document_collections.rb', line 74

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



60
61
62
 
# File 'lib/arango/database/document_collections.rb', line 60

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:



28
29
30
 
# File 'lib/arango/database/document_collections.rb', line 28

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.



50
51
52
 
# File 'lib/arango/database/document_collections.rb', line 50

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:



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

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