Enum Response 

pub enum Response {
    Hello {
        protocol_version: u32,
        kind: Kind,
        name: String,
        version: String,
        capabilities: Vec<String>,
        provides: Vec<PluginId>,
    },
    VersionMismatch {
        min_version: u32,
        max_version: u32,
    },
    Describe {
        connection_fields: Vec<ConnectionField>,
        option_fields: Vec<OptionField>,
        identifier_quote: Option<String>,
        string_literal: Option<String>,
        message_limit: Option<u64>,
        single_writer: Option<SingleWriter>,
    },
    Validated {
        errors: Vec<String>,
        warnings: Vec<String>,
    },
    Ok {},
    Result {
        columns: Vec<String>,
    },
    ResultEnd {
        rows: u64,
    },
    NoResult {
        rows_affected: Option<u64>,
    },
    Catalog {
        catalog: Value,
    },
    NeedFonts {
        font: FontRequest,
    },
    Written {
        files: Vec<String>,
        warnings: Vec<String>,
    },
    Delivered {
        location: String,
        attempts: Option<u32>,
    },
    Loaded {
        relation: String,
        rows: u64,
        warning: Option<String>,
    },
    Error {
        message: String,
        kind: Option<String>,
        code: Option<String>,
    },
    Log {
        level: LogLevel,
        message: String,
        fields: Map<String, Value>,
    },
    Progress {
        message: Option<String>,
        done: Option<u64>,
        total: Option<u64>,
    },
}

Plugin → core.

Variants

Hello

Fields

protocol_version: u32

kind: Kind

name: String

version: String

capabilities: Vec<String>

provides: Vec<PluginId>

Every plugin the executable serves; empty for one that serves only kind/name.

VersionMismatch

Fields

min_version: u32

max_version: u32

Describe

Fields

connection_fields: Vec<ConnectionField>

option_fields: Vec<OptionField>

identifier_quote: Option<String>

Source: the character the database quotes identifiers with (" for DuckDB and Postgres, a backtick for Databricks). Core uses it to quote names a project asks to quote (a source’s quoting:). Every source sets it; other kinds leave it out.

string_literal: Option<String>

Source: how core spells a string holding ' or \ when it writes one into SQL (an inlined lookup): absent or chr for chr(39)/chr(92), backslash for \'/\\ inside the quotes (a database without chr(), such as ClickHouse).

message_limit: Option<u64>

Destination advertising message: the most characters a message may have in the service, after translation. Core shows it next to a message’s length in a preview.

single_writer: Option<SingleWriter>

Source: a connection field naming a file only one process may write at a time (DuckDB’s path). Core runs one Binding at a time on a connection that sets it, whatever the entry’s threads:.

Validated

Every problem with the options, each a sentence naming the key; empty when they’re fine.

Fields

errors: Vec<String>

warnings: Vec<String>

Problems that don’t stop a run (an unknown key); validate_connection only.

Ok

Result

A result set follows as Arrow frames, ended by result_end.

Fields

columns: Vec<String>

ResultEnd

Fields

rows: u64

NoResult

Fields

rows_affected: Option<u64>

Catalog

A source’s catalogue, using the existing dre/catalog/v1 document shape.

Fields

catalog: Value

NeedFonts

A format needs a pinned registry font before completing its write.

Fields

font: FontRequest

Written

Fields

files: Vec<String>

warnings: Vec<String>

Things the person should know about the files (a value written as text, say).

Delivered

Fields

location: String

attempts: Option<u32>

How many tries the delivery took, when it was more than one (protocol 1).

Loaded

relation is what SQL uses to read the loaded rows. warning, when set, is shown to the user (e.g. the database has no bulk path, so a load this size is slow).

Fields

relation: String

rows: u64

warning: Option<String>

Error

The request failed. kind is one of ERROR_KINDS; code names the problem, namespaced by the plugin (sftp/host-key-mismatch). Both are optional (protocol 0 has neither): without a code, core reports the failure under its own code for the step; a code without a kind counts as internal.

Fields

message: String

kind: Option<String>

code: Option<String>

Log

Protocol 1: a log line, while a request runs (with its id) or between requests.

Fields

level: LogLevel

message: String

fields: Map<String, Value>

Structured context ({"attempt": 2}); never secrets.

Progress

Protocol 1, optional: how far a long request has got. Core shows it when present.

Fields

message: Option<String>

done: Option<u64>

total: Option<u64>

Implementations

impl Response

pub fn error(message: impl Into<String>) -> Response

An error reply with only a message.

Trait Implementations

impl Clone for Response

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 Response

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Response

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Response

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Response

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Response