Enum Command 

pub enum Command {
    Use {
        namespace: Option<String>,
        database: Option<String>,
    },
    Signup {
        credentials: Object,
    },
    Signin {
        credentials: Object,
    },
    Authenticate {
        token: Token,
    },
    Refresh {
        token: Token,
    },
    Invalidate,
    Begin,
    Rollback {
        txn: Uuid,
    },
    Commit {
        txn: Uuid,
    },
    Revoke {
        token: Token,
    },
    Query {
        txn: Option<Uuid>,
        query: Cow<'static, str>,
        variables: Variables,
    },
    ExportFile {
        path: PathBuf,
        config: Option<DbExportConfig>,
    },
    ExportMl {
        path: PathBuf,
        config: MlExportConfig,
    },
    ExportBytes {
        bytes: Sender<Result<Vec<u8>, Error>>,
        config: Option<DbExportConfig>,
    },
    ExportBytesMl {
        bytes: Sender<Result<Vec<u8>, Error>>,
        config: MlExportConfig,
    },
    ImportFile {
        path: PathBuf,
    },
    ImportMl {
        path: PathBuf,
    },
    Health,
    Version,
    Set {
        key: String,
        value: Value,
    },
    Unset {
        key: String,
    },
    SubscribeLive {
        uuid: Uuid,
        notification_sender: Sender<Result<Notification, Error>>,
    },
    Kill {
        uuid: Uuid,
    },
    Attach {
        session_id: Uuid,
    },
    Detach {
        session_id: Uuid,
    },
    Run {
        name: String,
        version: Option<String>,
        args: Array,
    },
}

The operations an engine can be asked to perform.

Variants

Use

Select the namespace and/or database for the session.

Fields

namespace: Option<String>

The namespace to use, or None to leave it unchanged.

database: Option<String>

The database to use, or None to leave it unchanged.

Signup

Sign up as a record user and authenticate the session.

Fields

credentials: Object

The signup credentials.

Signin

Sign in and authenticate the session.

Fields

credentials: Object

The signin credentials.

Authenticate

Authenticate the session with an existing token.

Fields

token: Token

The token to authenticate with.

Refresh

Exchange a refresh token for a fresh token pair.

Fields

token: Token

The token carrying the refresh token.

Invalidate

Drop the session’s authentication.

Begin

Begin a manual transaction.

Rollback

Cancel a manual transaction.

Fields

txn: Uuid

The transaction to cancel.

Commit

Commit a manual transaction.

Fields

txn: Uuid

The transaction to commit.

Revoke

Invalidate a refresh token so it can no longer be redeemed.

Fields

token: Token

The token carrying the refresh token.

Query

Execute a query, optionally inside a manual transaction.

Fields

txn: Option<Uuid>

The transaction to run in, or None for an implicit one.

query: Cow<'static, str>

The query text.

variables: Variables

The variables bound for this query only.

ExportFile

Export the database to a file.

Fields

path: PathBuf

The file to write.

config: Option<DbExportConfig>

What to include in the export.

ExportMl

Export a machine learning model to a file.

Fields

path: PathBuf

The file to write.

config: MlExportConfig

The model to export.

ExportBytes

Export the database to a channel.

Fields

bytes: Sender<Result<Vec<u8>, Error>>

Where the export is streamed.

config: Option<DbExportConfig>

What to include in the export.

ExportBytesMl

Export a machine learning model to a channel.

Fields

bytes: Sender<Result<Vec<u8>, Error>>

Where the export is streamed.

config: MlExportConfig

The model to export.

ImportFile

Import a database export from a file.

Fields

path: PathBuf

The file to read.

ImportMl

Import a machine learning model from a file.

Fields

path: PathBuf

The file to read.

Health

Check that the engine is reachable.

Version

Report the database version.

Set

Set a session variable.

Fields

key: String

The variable name.

value: Value

The value to bind, or Value::None to remove it.

Unset

Remove a session variable.

Fields

key: String

The variable name.

SubscribeLive

Register the channel a live query’s notifications are delivered on.

Fields

uuid: Uuid

The live query.

notification_sender: Sender<Result<Notification, Error>>

Where notifications are delivered.

Kill

Kill a live query.

Fields

uuid: Uuid

The live query.

Attach

Adopt an existing remote session.

Fields

session_id: Uuid

The session to adopt.

Detach

Release a remote session without ending it.

Fields

session_id: Uuid

The session to release.

Run

Call a function or a machine learning model.

Fields

name: String

The function or model name.

version: Option<String>

The model version, if any.

args: Array

The arguments to pass.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.