Struct DescribeParams 

pub struct DescribeParams {
    pub table: Option<String>,
    pub database: Option<String>,
}

Parameters for the describe tool. Both fields are optional to preserve backward compatibility with callers that invoke describe with no args to get the full workspace listing.

Fields

table: Option<String>

If set, return the schema and row count for just this table. Omit to list every public table in the workspace.

database: Option<String>

Target database alias. Omit to describe tables in the ephemeral primary; pass "persistent" or a user-attached alias to describe tables in another database.

Trait Implementations

impl Debug for DescribeParams

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

Formats the value using the given formatter.

impl Default for DescribeParams

fn default() -> DescribeParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DescribeParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DescribeParams

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.