surreal
surreal v1.1.0

View Source surreal (surreal v1.1.0)

Base module of the library.

Link to this section Summary

Functions

authenticate(Connection, Token)
Authenticates the current connection with a JWT token.
change(Connection, TableOrId, Data) deprecated
Change all records in a table, or a specific record.
close(Connection)
Close connection.
create(Connection, TableOrId, Data)
Creates a record in the database.
delete(Connection, TableOrId)
Deletes all records in a table, or a specific record, from the database.
invalidate(Connection)
Invalidates the authentication for the current connection.
merge(Connection, TableOrId, Data)
Change all records in a table, or a specific record.
modify(Connection, TableOrId, Data) deprecated
Applies JSON Patch changes to all records in a table, or a specific record.
patch(Connection, TableOrId, Data)
Applies JSON Patch changes to all records in a table, or a specific record.
query(Connection, Query)
Runs a set of SurrealQL statements against the database.
query(Connection, Query, Params)
Runs a set of SurrealQL statements against the database with parameters.
select(Connection, TableOrId)
Selects all records in a table, or a specific record, from the database.
set(Connection, Name, Value)
Assigns a value as a parameter for this connection.
signin(Connection, Username, Password)
Signs in to a specific authentication scope.
signin(Connection, Namespace, Database, Scope, Username, Password)
Signs in to a specific authentication scope with more advanced inputs.
signup(Connection, Namespace, Database, Scope, Username, Password)
Signs up to a specific authentication scope.
start(Url)
Same with "start_link" but without linking process.
start_link(Url)
Connects to a local or remote database endpoint.
unset(Connection, Name)
Removes a parameter for this connection
update(Connection, TableOrId, Data)
Updates all records in a table, or a specific record.
use(Connection, Namespace, Database)
Switch to a specific namespace and database.

Link to this section Functions

Link to this function

authenticate(Connection, Token)

View Source 
-spec authenticate(Connection :: gen_server:server_ref(), Token :: string()) ->
                surreal_response:result().
Authenticates the current connection with a JWT token.
Link to this function

change(Connection, TableOrId, Data)

View Source
This function is deprecated. Please use surreal:merge/3 instead.. 
-spec change(Connection :: gen_server:server_ref(), TableOrId :: string(), Data :: map()) ->
          surreal_response:result().
Change all records in a table, or a specific record.
Link to this function

close(Connection)

View Source 
-spec close(Connection :: gen_server:server_ref()) -> shutdown_ok.
Close connection.
Link to this function

create(Connection, TableOrId, Data)

View Source 
-spec create(Connection :: gen_server:server_ref(), TableOrId :: string(), Data :: map()) ->
          surreal_response:result().
Creates a record in the database.
Link to this function

delete(Connection, TableOrId)

View Source 
-spec delete(Connection :: gen_server:server_ref(), TableOrId :: string()) -> surreal_response:result().
Deletes all records in a table, or a specific record, from the database.
Link to this function

invalidate(Connection)

View Source 
-spec invalidate(Connection :: gen_server:server_ref()) -> surreal_response:result().
Invalidates the authentication for the current connection.
Link to this function

merge(Connection, TableOrId, Data)

View Source 
-spec merge(Connection :: gen_server:server_ref(), TableOrId :: string(), Data :: map()) ->
         surreal_response:result().
Change all records in a table, or a specific record.
Link to this function

modify(Connection, TableOrId, Data)

View Source
This function is deprecated. Please use surreal:patch/3 instead.. 
-spec modify(Connection :: gen_server:server_ref(), TableOrId :: string(), Data :: map()) ->
          surreal_response:result().
Applies JSON Patch changes to all records in a table, or a specific record.
Link to this function

patch(Connection, TableOrId, Data)

View Source 
-spec patch(Connection :: gen_server:server_ref(), TableOrId :: string(), Data :: map()) ->
         surreal_response:result().
Applies JSON Patch changes to all records in a table, or a specific record.
Link to this function

query(Connection, Query)

View Source 
-spec query(Connection :: gen_server:server_ref(), Query :: string()) -> surreal_response:result().
Runs a set of SurrealQL statements against the database.
Link to this function

query(Connection, Query, Params)

View Source 
-spec query(Connection :: gen_server:server_ref(), Query :: string(), Params :: map()) ->
         surreal_response:result().
Runs a set of SurrealQL statements against the database with parameters.
Link to this function

select(Connection, TableOrId)

View Source 
-spec select(Connection :: gen_server:server_ref(), TableOrId :: string()) -> surreal_response:result().
Selects all records in a table, or a specific record, from the database.
Link to this function

set(Connection, Name, Value)

View Source 
-spec set(Connection :: gen_server:server_ref(), Name :: string(), Value :: term()) ->
       surreal_response:result().
Assigns a value as a parameter for this connection.
Link to this function

signin(Connection, Username, Password)

View Source 
-spec signin(Connection :: gen_server:server_ref(), Username :: string(), Password :: string()) ->
          surreal_response:result().
Signs in to a specific authentication scope.
Link to this function

signin(Connection, Namespace, Database, Scope, Username, Password)

View Source 
-spec signin(Connection :: gen_server:server_ref(),
       Namespace :: string(),
       Database :: string(),
       Scope :: string(),
       Username :: string(),
       Password :: string()) ->
          surreal_response:result().
Signs in to a specific authentication scope with more advanced inputs.
Link to this function

signup(Connection, Namespace, Database, Scope, Username, Password)

View Source 
-spec signup(Connection :: gen_server:server_ref(),
       Namespace :: string(),
       Database :: string(),
       Scope :: string(),
       Username :: string(),
       Password :: string()) ->
          surreal_response:result().
Signs up to a specific authentication scope.
Link to this function

start(Url)

View Source 
-spec start(Url :: string()) -> {ok, pid()} | {error, term()}.
Same with "start_link" but without linking process.
Link to this function

start_link(Url)

View Source 
-spec start_link(Url :: string()) -> {ok, pid()} | {error, term()}.
Connects to a local or remote database endpoint.
Link to this function

unset(Connection, Name)

View Source 
-spec unset(Connection :: gen_server:server_ref(), Name :: string()) -> surreal_response:result().
Removes a parameter for this connection
Link to this function

update(Connection, TableOrId, Data)

View Source 
-spec update(Connection :: gen_server:server_ref(), TableOrId :: string(), Data :: map()) ->
          surreal_response:result().
Updates all records in a table, or a specific record.
Link to this function

use(Connection, Namespace, Database)

View Source 
-spec use(Connection :: gen_server:server_ref(), Namespace :: string(), Database :: string()) ->
       surreal_response:result().
Switch to a specific namespace and database.