Module: Arango::Edge::ClassMethods

Defined in:
lib/arango/edge/class_methods.rb

Instance Method Summary collapse

Instance Method Details

#all(offset: 0, limit: nil, batch_size: nil, edge_collection:) ⇒ Object

returns Array of Edge



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/arango/edge/class_methods.rb', line 8

def all (offset: 0, limit: nil, batch_size: nil, edge_collection:)
  bind_vars = {}
  query = "FOR doc IN #{edge_collection.name}"
  if limit && offset
    query << "\n LIMIT @offset, @limit"
    bind_vars[:offset] = offset
    bind_vars[:limit] = limit
  end
  raise Arango::Error.new err: "offset must be used with limit" if offset > 0 && !limit
  query << "\n RETURN doc"
  body = { query: query }
  unless bind_vars.empty?
    body[:bind_vars] = bind_vars
  end
  if batch_size
    body[:batch_size] = batch_size
  end
  result = Arango::Requests::Cursor::Create.execute(server: edge_collection.server, body: body)
  result_proc = ->(result) { result.result.map { |edge_attr| Arango::Edge::Base.new(attributes: edge_attr, edge_collection: edge_collection) }}
  final_result = result_proc.call(result)
  if result[:has_more]
    edge_collection.instance_variable_set(:@cursor, result)
    edge_collection.instance_variable_set(:@batch_proc, result_proc)
    unless batch_size
      while edge_collection.has_more?
        b = edge_collection.next_batch
        final_result += b if b
      end
    end
  end
  final_result
end

#create_edges(edges, wait_for_sync: nil, edge_collection:) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/arango/edge/class_methods.rb', line 97

def create_edges (edges, wait_for_sync: nil, edge_collection:)
  edges = [edges] unless edges.is_a? Array
  edges = edges.map{ |d| _attributes_from_arg(d) }
  params = { returnNew: true }
  params[:waitForSync] = wait_for_sync unless wait_for_sync.nil?
  args = { collection: edge_collection.name }
  result = Arango::Requests::Document::CreateMultiple.execute(server: edge_collection.server, args: args, params: params, body: edges)
  result.map do |edge|
    # returnNew does not work for 'multiple'
    Arango::Edge::Base.get(key: edge[:_key], edge_collection: edge_collection)
  end
end

#delete(key: nil, attributes: {}, ignore_revs: false, wait_for_sync: nil, edge_collection:) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/arango/edge/class_methods.rb', line 232

def delete (key: nil, attributes: {}, ignore_revs: false, wait_for_sync: nil, edge_collection:)
  edge = _attributes_from_arg(attributes)
  edge[:_key] = key if key
  params = { }
  params[:waitForSync] = wait_for_sync unless wait_for_sync.nil?
  headers = nil
  headers = { "If-Match": edge[:_rev] } if !ignore_revs && edge.key?(:_rev)
  args = { collection: edge_collection.name, key: edge[:_key] }
  Arango::Requests::Document::Delete.execute(server: edge_collection.server, args: args, headers: headers, params: params)
end

#delete_edges(edges, ignore_revs: false, wait_for_sync: nil, edge_collection:) ⇒ Object 



243
244
245
246
247
248
249
250
 
# File 'lib/arango/edge/class_methods.rb', line 243

def delete_edges (edges, ignore_revs: false, wait_for_sync: nil, edge_collection:)
  edges = [edges] unless edges.is_a? Array
  edges = edges.map{ |d| _attributes_from_arg(d) }
  params = { ignoreRevs: ignore_revs }
  params[:waitForSync] = wait_for_sync unless wait_for_sync.nil?
  args = { collection: edge_collection.name }
  Arango::Requests::Document::DeleteMultiple.execute(server: edge_collection.server, args: args, params: params, body: edges)
end

#exists?(key: nil, attributes: {}, match_rev: nil, edge_collection:) ⇒ Boolean

Returns:

  • (Boolean)

Raises:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/arango/edge/class_methods.rb', line 75

def exists? (key: nil, attributes: {}, match_rev: nil, edge_collection:)
  edge = _attributes_from_arg(attributes)
  if key.nil?
    return !!self.get(key: key, attributes: attributes, edge_collection: edge_collection)
  end
  edge[:_key] = key
  headers = { }
  raise Arango::Error.new("Edge with key required!") unless edge.key?(:_key)
  if edge.key?(:_key) && edge.key?(:_rev) && match_rev == true
    headers[:'If-Match'] = edge[:_rev]
  elsif edge.key?(:_key) && edge.key?(:_rev) && match_rev == false
    headers[:'If-None-Match'] = edge[:_rev]
  end
  args = { collection: edge_collection.name, key: edge[:_key] }
  begin
    Arango::Requests::Document::Head.execute(server: edge_collection.server, args: args, headers: headers)
  rescue Error
    return false
  end
  true
end

#find_edges_matching(attributes, edge_collection:) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/arango/edge/class_methods.rb', line 174

def find_edges_matching (attributes, edge_collection:)
  vars = _attributes_from_arg(attributes)
  results = []
  result_edges = []
  args = { collection: edge_collection.name }
  if vars.key?(:_key)
    args[:key] = vars[:_key]
    result = Arango::Requests::Document::Get.execute(server: edge_collection.server, args: args)
    results << result
    result_edges << Arango::Edge::Base.new(attributes: result, edge_collection: edge_collection)
  else
    bind_vars = {}
    query = "FOR doc IN #{edge_collection.name}"
    i = 0
    vars.each do |k,v|
      i += 1
      query << "\n FILTER doc.@key#{i} == @value#{i}"
      bind_vars["key#{i}"] = k.to_s
      bind_vars["value#{i}"] = v
    end
    query << "\n RETURN doc"
    aql = AQL.new(query: query, database: edge_collection.database, bind_vars: bind_vars, block: ->(_, result) do
                    result.result.each do |res|
                      result_edges << Arango::Edge::Base.new(attributes: res, edge_collection: edge_collection)
                      result_edges
                    end
                  end
                 )
    results += aql.request
  end
  results
end

#get(key: nil, attributes: {}, edge_collection:) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/arango/edge/class_methods.rb', line 110

def get (key: nil, attributes: {}, edge_collection:)
  edge = _attributes_from_arg(attributes)
  edge[:_key] = key if key
  if edge.key?(:_key)
    args = {collection: edge_collection.name, key: edge[:_key] }
    result = Arango::Requests::Document::Get.execute(server: edge_collection.server, args: args)
    Arango::Edge::Base.new(attributes: result, edge_collection: edge_collection)
  else
    bind_vars = {}
    query = "FOR doc IN #{edge_collection.name}"
    i = 0
    edge.each do |k,v|
      i += 1
      query << "\n FILTER doc.@key#{i} == @value#{i}"
      bind_vars["key#{i}"] = k.to_s
      bind_vars["value#{i}"] = v
    end
    query << "\n LIMIT 1"
    query << "\n RETURN doc"
    aql = AQL.new(query: query, database: edge_collection.database, bind_vars: bind_vars, block: ->(_, result) do
                    Arango::Edge::Base.new(attributes: result.result.first, edge_collection: edge_collection) if result.result.first
                  end
                 )
    aql.request
  end
end

#get_edges(edges, edge_collection:) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/arango/edge/class_methods.rb', line 137

def get_edges (edges, edge_collection:)
  edges = [edges] unless edges.is_a? Array
  edges = edges.map{ |d| _attributes_from_arg(d) }
  results = []
  result_edges = []
  args = { collection: edge_collection.name }
  edges.each do |edge|
    if edge.key?(:_key)
      args[:key] = edge[:_key]
      result = Arango::Requests::Document::Get.execute(server: edge_collection.server, args: args)
      results << result
      result_edges << Arango::Edge::Base.new(attributes: result, edge_collection: edge_collection)
    else
      bind_vars = {}
      query = "FOR doc IN #{edge_collection.name}"
      i = 0
      edge.each do |k,v|
        i += 1
        query << "\n FILTER doc.@key#{i} == @value#{i}"
        bind_vars["key#{i}"] = k.to_s
        bind_vars["value#{i}"] = v
      end
      query << "\n LIMIT 1"
      query << "\n RETURN doc"
      aql = AQL.new(query: query, database: edge_collection.database, bind_vars: bind_vars, block: ->(_, result) do
                      result_edges << Arango::Edge::Base.new(attributes: result.result.first, edge_collection: edge_collection) if result.result.first
                      result_edges
                    end
                   )
      results << aql.request
    end
  end
  results
end

#list(offset: 0, limit: nil, batch_size: nil, edge_collection:) ⇒ Object

returns Array of keys



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/arango/edge/class_methods.rb', line 42

def list (offset: 0, limit: nil, batch_size: nil, edge_collection:)
  bind_vars = {}
  query = "FOR doc IN #{edge_collection.name}"
  if limit && offset
    query << "\n LIMIT @offset, @limit"
    bind_vars[:offset] = offset
    bind_vars[:limit] = limit
  end
  raise Arango::Error.new err: "offset must be used with limit" if offset > 0 && !limit
  query << "\n RETURN doc._key"
  body = { query: query }
  unless bind_vars.empty?
    body[:bind_vars] = bind_vars
  end
  if batch_size
    body[:batch_size] = batch_size
  end
  result = Arango::Requests::Cursor::Create.execute(server: edge_collection.server, body: body)
  result_proc = ->(result) { result.result }
  final_result = result_proc.call(result)
  if result[:has_more]
    edge_collection.instance_variable_set(:@cursor, result)
    edge_collection.instance_variable_set(:@batch_proc, result_proc)
    unless batch_size
      while edge_collection.has_more?
        b = edge_collection.next_batch
        final_result += b if b
      end
    end
  end
  final_result
end

#replace_edges(edges, ignore_revs: false, wait_for_sync: nil, edge_collection:) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/arango/edge/class_methods.rb', line 207

def replace_edges (edges, ignore_revs: false, wait_for_sync: nil, edge_collection:)
  edges = [edges] unless edges.is_a? Array
  edges = edges.map{ |d| _attributes_from_arg(d) }
  params = { returnNew: true, ignoreRevs: ignore_revs }
  params[:waitForSync] = wait_for_sync unless wait_for_sync.nil?
  args = { collection: edge_collection.name }
  result = Arango::Requests::Document::ReplaceMultiple.execute(server: edge_collection.server, args: args, params: params, body: edges)
  result.map do |doc|
    Arango::Edge::Base.new(attributes: doc[:new], edge_collection: edge_collection)
  end
end

#update_edges(edges, ignore_revs: false, wait_for_sync: nil, merge_objects: nil, edge_collection:) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/arango/edge/class_methods.rb', line 219

def update_edges (edges, ignore_revs: false, wait_for_sync: nil, merge_objects: nil, edge_collection:)
  edges = [edges] unless edges.is_a? Array
  edges = edges.map{ |d| _attributes_from_arg(d) }
  params = { returnNew: true, ignoreRevs: ignore_revs }
  params[:waitForSync] = wait_for_sync unless wait_for_sync.nil?
  params[:mergeObjects] = merge_objects unless merge_objects.nil?
  args = { collection: edge_collection.name }
  result = Arango::Requests::Document::UpdateMultiple.execute(server: edge_collection.server, args: args, params: params, body: edges)
  result.map do |doc|
    Arango::Edge::Base.new(attributes: doc[:new], edge_collection: edge_collection)
  end
end