Struct VTabArguments

pub struct VTabArguments {
    pub module_name: String,
    pub database_name: String,
    pub table_name: String,
    pub arguments: Vec<String>,
}

Represents all the arguments given to the virtual table implementation during xCreate, from the underlying argv/argc strings. Parsed to be more easily readable.

You most likely want to pass in .arguments into vtab_argparse::parse_argument.

Fields

module_name: String

Name of the module being invoked, the argument in the USING clause. Example: "CREATE VIRTUAL TABLE xxx USING custom_vtab" would have a module_name of "custom_vtab". Sourced from argv[0]

database_name: String

Name of the database where the virtual table will be created, typically "main" or "temp" or another name from an ATTACH’ed database. Sourced from argv[1]

table_name: String

Name of the table being created. Example: "CREATE VIRTUAL TABLE xxx USING custom_vtab" would have a table_name of "xxx". Sourced from argv[2]

arguments: Vec<String>

The remaining arguments given in the constructor of the virtual table, inside CREATE VIRTUAL TABLE xxx USING custom_vtab(...). Sourced from argv[3:]