Struct PluginProcess 

pub struct PluginProcess { /* private fields */ }

Implementations

impl PluginProcess

pub fn start(path: &Path, log: LogSink) -> Result<PluginProcess>

Spawn the plugin at path and complete the handshake.

pub fn start_in( path: &Path, log: LogSink, cwd: Option<&Path>, ) -> Result<PluginProcess>

Like start, running the plugin in cwd (core uses the project directory).

pub fn start_for( path: &Path, plugin: Option<&PluginId>, log: LogSink, cwd: Option<&Path>, ) -> Result<PluginProcess>

Like start_in, asking the executable for plugin (one of a package’s plugins).

pub fn start_with( path: &Path, log: LogSink, versions: (u32, u32), timeout: Duration, ) -> Result<PluginProcess>

Spawn and handshake offering an explicit version range (the conformance suite uses this).

pub fn spawn(path: &Path, log: LogSink) -> Result<PluginProcess>

Spawn without a handshake (for tests that probe raw protocol behaviour).

pub fn spawn_env( path: &Path, log: LogSink, env: &[(&str, &str)], ) -> Result<PluginProcess>

Spawn with extra environment variables, without a handshake.

pub fn spawn_in( path: &Path, log: LogSink, env: &[(&str, &str)], cwd: Option<&Path>, ) -> Result<PluginProcess>

Spawn with extra environment variables and a working directory, without a handshake.

pub fn ask_for(&mut self, plugin: Option<PluginId>)

Name the plugin to ask for in the handshake (None: a package’s first).

pub fn handshake( &mut self, (min, max): (u32, u32), timeout: Duration, ) -> Result<()>

Complete the handshake on a process from spawn/spawn_env.

pub fn label(&self) -> &str

pub fn path(&self) -> &Path

pub fn info(&self) -> &PluginInfo

pub fn canceller(&self) -> Canceller

A handle that can cancel the running request from another thread. Only a plugin on protocol 1 or later understands cancel.

pub fn has(&self, capability: &str) -> bool

pub fn send(&mut self, req: &Request) -> Result<()>

Send a request. From protocol 1 it carries an id: a new one, or for the messages that continue a request (result_set_end, finish, cancel) the running request’s.

pub fn send_batch(&mut self, batch: &RecordBatch) -> Result<()>

pub fn recv( &mut self, timeout: Option<Duration>, waiting_for: &'static str, ) -> Result<Incoming>

Receive the next message. timeout of None waits as long as the plugin is alive. log and progress messages go to the log sink on the way.

pub fn recv_raw(&mut self, timeout: Duration) -> Result<Value>

The next frame’s JSON as sent, with nothing skipped or checked (conformance tests).

pub fn recv_json(&mut self, waiting_for: &'static str) -> Result<Response>

Receive a JSON response, turning error into HostError::Plugin.

pub fn describe(&mut self) -> Result<Vec<ConnectionField>>

pub fn describe_all( &mut self, ) -> Result<(Vec<ConnectionField>, Vec<OptionField>)>

The connection fields and the options the plugin declares.

pub fn description(&mut self) -> Result<Description>

The whole describe reply.

pub fn validate_connection( &mut self, connection: Map<String, Value>, unresolved: Vec<String>, ) -> Result<(Vec<String>, Vec<String>)>

Check a profile entry’s connection settings without connecting (protocol 1): the errors and the warnings. unresolved keys (an unset env_var()) are sent as null.

pub fn validate(&mut self, options: Map<String, Value>) -> Result<Vec<String>>

Check a config block of options (needs validate); returns every problem found.

pub fn open( &mut self, connection: Map<String, Value>, read_only: bool, ) -> Result<()>

pub fn open_sandboxed(&mut self, connection: Map<String, Value>) -> Result<()>

Open a read-only session that may not reach files, programs or the network beyond the database, where the plugin supports it (dre query).

pub fn check(&mut self, sql: &str) -> Result<()>

pub fn execute( &mut self, sql: &str, row_limit: Option<u64>, on_batch: impl FnMut(&SchemaRef, RecordBatch) -> Result<(), String>, ) -> Result<Execution>

Run one statement, handing every batch to on_batch as it arrives.

pub fn write_begin( &mut self, path: &str, format: &str, options: Map<String, Value>, result_sets: Vec<ResultSetMeta>, template: Option<Value>, ) -> Result<()>

Start a format write; follow with write_result_set per result set, then write_finish.

pub fn write_result_set( &mut self, schema: &SchemaRef, batches: impl IntoIterator<Item = RecordBatch>, ) -> Result<()>

Stream one result set: at least one batch (carrying the schema), then the end marker.

pub fn load( &mut self, name: &str, schema: &SchemaRef, batches: impl IntoIterator<Item = RecordBatch>, ) -> Result<(String, Option<String>)>

Load rows into a temporary table on the source’s session. Returns the relation to use in SQL, and the plugin’s warning, if any. Only for plugins advertising load.

pub fn write_finish(&mut self) -> Result<Vec<String>>

pub fn write_finish_with_warnings( &mut self, ) -> Result<(Vec<String>, Vec<String>)>

write_finish, also returning the format’s warnings.

pub fn deliver( &mut self, local_path: &str, remote_path: Option<&str>, connection: Map<String, Value>, ) -> Result<String>

Deliver one file with no plugin options.

pub fn deliver_files( &mut self, files: &[DeliveryFile], connection: Map<String, Value>, options: Map<String, Value>, ) -> Result<String>

Deliver files in one request with the destination entry’s options. More than one file needs a plugin advertising multi_file; call once per file otherwise.

pub fn deliver_message( &mut self, message: &Message, attach: &[DeliveryFile], connection: Map<String, Value>, options: Map<String, Value>, ) -> Result<String>

Deliver a message, with attach files, to a plugin advertising message.

pub fn last_attempts(&self) -> u32

How many tries the last delivery took: 1, or more when the plugin retried a temporary error.

pub fn close(self) -> Result<()>

Ask the plugin to exit, and wait for it.

pub fn write_raw(&mut self, bytes: &[u8]) -> Result<()>

Raw access for protocol tests: write arbitrary bytes to the plugin.

pub fn wait_exit(&mut self, timeout: Duration) -> Option<ExitStatus>

Wait up to timeout for the process to exit.

Trait Implementations

impl Drop for PluginProcess

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.