Struct AttachDatabaseParams 

pub struct AttachDatabaseParams {
    pub alias: String,
    pub kind: String,
    pub path: Option<String>,
    pub writable: Option<bool>,
    pub on_missing: Option<String>,
}

Parameters for the attach_database tool. Mirrors AttachSpec except that these attachments live for the rest of the MCP session (or until detach_database is called).

Fields

alias: String

Alias to register the attachment under. Must be a SQL identifier ([A-Za-z_][A-Za-z0-9_]{0,62}) and cannot be local (reserved for the primary workspace).

kind: String

Attachment kind. Only "local_file" is supported today.

path: Option<String>

Absolute path to a .hyper file. Required when kind == "local_file". The file must be idle — another MCP server or hyperd instance holding it will cause a RESOURCE_BUSY error.

writable: Option<bool>

If true, copy_query (and raw execute) may target this attachment. Defaults to false so sources stay safe from accidental mutation.

on_missing: Option<String>

What to do when kind == "local_file" and path does not yet exist:

• "error" (default) — return FILE_NOT_FOUND. Matches the pre-existing contract.
• "create" — issue CREATE DATABASE IF NOT EXISTS against the path first, then attach the resulting empty file. Requires writable: true (otherwise the empty DB would be unusable) and is rejected when the server is running with --read-only. The parent directory must already exist.

Trait Implementations

impl Debug for AttachDatabaseParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AttachDatabaseParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AttachDatabaseParams

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.