Module: Arango::Database::EdgeCollections

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

Overview

Arango Database EdgeCollections

Instance Method Summary collapse

Instance Method Details

#all_edge_collections(exclude_system: true) ⇒ Array<Arango::EdgeCollection>

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

def all_edge_collections(exclude_system: true)
  Arango::EdgeCollection::Base.all(exclude_system: exclude_system, database: self)
end

#create_edge_collection(name:) ⇒ Arango::DocumentCollection

Creates a new edge collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



16
17
18
 
# File 'lib/arango/database/edge_collections.rb', line 16

def create_edge_collection(name:)
  Arango::EdgeCollection::Base.new(name: name, database: self).create
end

#delete_edge_collection(name:) ⇒ Object

Removes a edge collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:

  • nil



46
47
48
 
# File 'lib/arango/database/edge_collections.rb', line 46

def delete_edge_collection(name:)
  Arango::EdgeCollection::Base.drop(name: name, database: self)
end

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

Check if edge collection exists.

Parameters:

  • name (String) —

    Name of the collection

Returns:

  • (Boolean) 


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

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

#get_edge_collection(name:) ⇒ Arango::Database Also known as: fetch_edge_collection, retrieve_edge_collection

Get edge collection from the database.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



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

def get_edge_collection(name:)
  Arango::EdgeCollection::Base.get(name: name, database: self)
end

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

Retrieves a list of edge collections.

Parameters:

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

    Optional, default true, exclude system collections.

Returns:

  • (Array<String>) —

    List of collection names.



39
40
41
 
# File 'lib/arango/database/edge_collections.rb', line 39

def list_edge_collections(exclude_system: true)
  Arango::EdgeCollection::Base.list(exclude_system: exclude_system, database: self)
end

#new_edge_collection(name:) ⇒ Arango::DocumentCollection

Instantiates a new edge collection.

Parameters:

  • name (String) —

    The name of the collection.

Returns:



32
33
34
 
# File 'lib/arango/database/edge_collections.rb', line 32

def new_edge_collection(name:)
  Arango::EdgeCollection::Base.new(name: name, type: :edge, database: self)
end