Struct automaat_processor_sql_query::SqlQuery

pub struct SqlQuery {
    pub statement: String,
    pub url: Url,
}

The processor configuration.

Fields

statement: String

The SQL statement to execute. This MUST start with "SELECT ...".

url: Url

The URL of the database server.

Use URLs such as postgres://postgres:mypassword@127.0.0.1/my_database

Trait Implementations

impl Eq for SqlQuery

impl PartialEq<SqlQuery> for SqlQuery

fn eq(&self, other: &SqlQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SqlQuery) -> bool

This method tests for !=.

impl Clone for SqlQuery

fn clone(&self) -> SqlQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SqlQuery

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

Formats the value using the given formatter.

impl<'a> Processor<'a> for SqlQuery

const NAME: &'static str

The human-formatted name of the processor, used to visually identify this processor amongst others.

type Error = Error

If a processor fails its intended purpose, the returned error is turned into a string, and shown in the automaat-web-client application.

type Output = String

The processor can return any (successful) output it wants, as long as that type implements the [std::fmt::Display] trait.

fn validate(&self) -> Result<(), Self::Error>

Validate that the provided statement is valid, and the url has a supported scheme.

Errors

If the statement contains invalid syntax, the Error::Syntax error variant is returned.

If multiple statements are detected, the Error::MultipleStatements error variant is returned.

If the statement does not start with "SELECT", the Error::StatementType error variant is returned.

If the url scheme does not match postgres, the Error::Scheme error variant is returned.

fn run(&self, _context: &Context) -> Result<Option<Self::Output>, Self::Error>

Run the provided statement against a database and return the values as an array of JSON objects.

Output

If no records are found, None is returned.

If one or more records are found, a JSON array of objects is returned. Each object contains the column names as its keys, and the record values as its values.

Errors

If a database error occurs, the relevant database error type (such as Error::Postgres) is returned.

If an unsupported data type is returned, the Error::ReturnType error is returned.

If anything happens during serialization, the Error::Serde error is returned.

impl<'de> Deserialize<'de> for SqlQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for SqlQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.