ex_orient_rest v0.1.2 ExOrientRest.Types

Link to this section Summary

Types

Properties of an active connection to the DB, which has the HTTP Keep-Alive set by default. We store the most recent cookie as well

Valid requests to make on a request of the type, with a database

Properties for connecting to the remote server, including Basic authentication credentials

An error we want to return to the client

Valid HTTP Request types

Link to this section Types

Link to this type db_connection()
db_connection() :: %{props: db_properties(), database: String.t()}

Properties of an active connection to the DB, which has the HTTP Keep-Alive set by default. We store the most recent cookie as well.

Link to this type db_delete_requests()
db_delete_requests() :: :document | :index | :database
Link to this type db_get_requests()
db_get_requests() ::
  :connect |
  :database |
  :class |
  :cluster |
  :function |
  :export |
  :disconnect |
  :document |
  :listDatabases |
  :documentbyclass |
  :allocation |
  :index |
  :query

Valid requests to make on a request of the type, with a database

Link to this type db_head_requests()
db_head_requests() :: :document | :documentbyclass
Link to this type db_patch_requests()
db_patch_requests() :: :document
Link to this type db_post_requests()
db_post_requests() ::
  :database |
  :class |
  :property |
  :command |
  :batch |
  :function |
  :import |
  :document
Link to this type db_properties()
db_properties() :: %{host: String.t(), port: non_neg_integer(), username: String.t(), password: String.t(), ssl: boolean()}

Properties for connecting to the remote server, including Basic authentication credentials.

Link to this type db_put_requests()
db_put_requests() :: :document | :index
Link to this type err()
err() :: %{reason: any(), status_code: integer()}

An error we want to return to the client.

Link to this type http_method()
http_method() :: :get | :head | :post | :put | :patch | :delete

Valid HTTP Request types