my_arangoex v0.1.0 MyArangoex.Simple

ArangoDB Simple methods

Summary

Functions

all(endpoint, collection, opts \\ [])

Return all documents

any(endpoint, collection)

Return a random document

find_by_example(endpoint, collection, example)

Find documents matching an example

lookup_by_keys(endpoint, collection, keys)

Find documents by their keys

near(endpoint, collection, latitude, longitude, opts \\ [])

Returns documents near a coordinate

query_by_example(endpoint, collection, example, opts \\ [])

Simple query by-example

query_fulltext(endpoint, collection, attribute_name, query, opts \\ [])

Fulltext index query

range(endpoint, collection, attribute_name, left, right, opts \\ [])

Simple range query

remove_by_example(endpoint, collection, example, opts \\ [])

Remove documents by example

remove_by_keys(endpoint, collection, keys, opts \\ [])

Remove documents by their keys

replace_by_example(endpoint, collection, example, new_value, opts \\ [])

Replace documents by example

update_by_example(endpoint, collection, example, new_value, opts \\ [])

Update documents by example

within(endpoint, collection, latitude, longitude, radius, opts \\ [])

Find documents within a radius around a coordinate

within_rectangle(endpoint, collection, latitude1, longitude1, latitude2, longitude2, opts \\ [])

Within rectangle query

Functions

all(endpoint, collection, opts \\ [])

all(MyArangoex.Endpoint.t, MyArangoex.Collection.t, keyword) :: MyArangoex.ok_error(map)

Return all documents

PUT /_api/simple/all

any(endpoint, collection)

any(MyArangoex.Endpoint.t, MyArangoex.Collection.t) :: MyArangoex.ok_error(map)

Return a random document

PUT /_api/simple/any

find_by_example(endpoint, collection, example)

find_by_example(MyArangoex.Endpoint.t, MyArangoex.Collection.t, map) :: MyArangoex.ok_error(map)

Find documents matching an example

PUT /_api/simple/first-example

lookup_by_keys(endpoint, collection, keys)

lookup_by_keys(MyArangoex.Endpoint.t, MyArangoex.Collection.t, [String.t]) :: MyArangoex.ok_error(map)

Find documents by their keys

PUT /_api/simple/lookup-by-keys

near(endpoint, collection, latitude, longitude, opts \\ [])

near(MyArangoex.Endpoint.t, MyArangoex.Collection.t, float, float, keyword) :: MyArangoex.ok_error(map)

Returns documents near a coordinate

PUT /_api/simple/near

query_by_example(endpoint, collection, example, opts \\ [])

query_by_example(MyArangoex.Endpoint.t, MyArangoex.Collection.t, map, keyword) :: MyArangoex.ok_error(map)

Simple query by-example

PUT /_api/simple/by-example

query_fulltext(endpoint, collection, attribute_name, query, opts \\ [])

query_fulltext(MyArangoex.Endpoint.t, MyArangoex.Collection.t, String.t, String.t, keyword) :: MyArangoex.ok_error(map)

Fulltext index query

PUT /_api/simple/fulltext

range(endpoint, collection, attribute_name, left, right, opts \\ [])

range(MyArangoex.Endpoint.t, MyArangoex.Collection.t, String.t, float, float, keyword) :: MyArangoex.ok_error(map)

Simple range query

PUT /_api/simple/range

remove_by_example(endpoint, collection, example, opts \\ [])

Remove documents by example

PUT /_api/simple/remove-by-example

remove_by_keys(endpoint, collection, keys, opts \\ [])

remove_by_keys(MyArangoex.Endpoint.t, MyArangoex.Collection.t, [String.t], keyword) :: MyArangoex.ok_error(map)

Remove documents by their keys

PUT /_api/simple/remove-by-keys

replace_by_example(endpoint, collection, example, new_value, opts \\ [])

replace_by_example(MyArangoex.Endpoint.t, MyArangoex.Collection.t, map, map, keyword) :: MyArangoex.ok_error(map)

Replace documents by example

PUT /_api/simple/replace-by-example

update_by_example(endpoint, collection, example, new_value, opts \\ [])

update_by_example(MyArangoex.Endpoint.t, MyArangoex.Collection.t, map, map, keyword) :: MyArangoex.ok_error(map)

Update documents by example

PUT /_api/simple/update-by-example

within(endpoint, collection, latitude, longitude, radius, opts \\ [])

within(MyArangoex.Endpoint.t, MyArangoex.Collection.t, float, float, float, keyword) :: MyArangoex.ok_error(map)

Find documents within a radius around a coordinate

PUT /_api/simple/within

within_rectangle(endpoint, collection, latitude1, longitude1, latitude2, longitude2, opts \\ [])

within_rectangle(MyArangoex.Endpoint.t, MyArangoex.Collection.t, float, float, float, float, keyword) :: MyArangoex.ok_error(map)

Within rectangle query

PUT /_api/simple/within-rectangle