my_arangoex v0.1.0 MyArangoex.Index

ArangoDB Index methods

Summary

Functions

create_fulltext(endpoint, collection_name, field_name, opts \\ [])

Create fulltext index

create_general(endpoint, collection_name, body)

Create index

create_geo(endpoint, collection_name, field_names, opts \\ [])

Create geo-spatial index

create_hash(endpoint, collection_name, field_names, opts \\ [])

Create hash index

create_persistent(endpoint, collection_name, field_names, opts \\ [])

Create a persistent index

create_skiplist(endpoint, collection_name, field_names, opts \\ [])

Create skip list

delete(endpoint, index_handle)

Delete index

index(endpoint, index_handle)

Read index

indexes(endpoint, collection_name)

Read all indexes of a collection

Functions

create_fulltext(endpoint, collection_name, field_name, opts \\ [])

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

Create fulltext index

POST /_api/index#fulltext

create_general(endpoint, collection_name, body)

create_general(MyArangoex.Endpoint.t, String.t, map) :: MyArangoex.ok_error(map)

Create index

POST /_api/index#general

create_geo(endpoint, collection_name, field_names, opts \\ [])

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

Create geo-spatial index

POST /_api/index#geo

create_hash(endpoint, collection_name, field_names, opts \\ [])

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

Create hash index

POST /_api/index#hash

create_persistent(endpoint, collection_name, field_names, opts \\ [])

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

Create a persistent index

POST /_api/index#persistent

create_skiplist(endpoint, collection_name, field_names, opts \\ [])

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

Create skip list

POST /_api/index#skiplist

delete(endpoint, index_handle)

delete(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

Delete index

DELETE /_api/index/{index-handle}

index(endpoint, index_handle)

index(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

Read index

GET /_api/index/{index-handle}

indexes(endpoint, collection_name)

indexes(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

Read all indexes of a collection

GET /_api/index