You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: plugins/PLUGIN_GUIDE.md
+59-2Lines changed: 59 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,12 +101,14 @@ The manifest tells Tabularis everything about your plugin.
101
101
|`schemas`| bool |`true` if the database supports named schemas (like PostgreSQL). Controls whether the schema selector is shown in the UI. |
102
102
|`views`| bool |`true` if the database supports views. Enables the views section in the explorer. |
103
103
|`routines`| bool |`true` if the database supports stored procedures/functions. |
104
+
|`triggers`| bool |`true` if the database supports triggers. Enables trigger-related UI for drivers that implement the trigger RPCs. |
104
105
|`file_based`| bool |`true` for local file databases (e.g., SQLite, DuckDB). Replaces host/port with a file path input in the connection form. |
105
106
|`folder_based`| bool |`true` for plugins that connect to a directory rather than a single file (e.g. CSV plugin). Replaces host/port with a folder picker. |
106
107
|`no_connection_required`| bool |`true` for API-based plugins that need no host, port, or credentials (e.g. a public REST API). Hides the entire connection form — the user only fills in the connection name. |
107
108
|`connection_string`| bool | Set `false` to hide the connection string import UI for this driver. Defaults to `true` for network drivers. `file_based` and `folder_based` drivers skip the import UI automatically regardless of this flag. |
108
109
|`connection_string_example`| string | Optional placeholder example shown in the connection string import field (e.g. `"clickhouse://user:pass@localhost:9000/db"`). Also accepted as camelCase `connectionStringExample`. |
109
110
|`identifier_quote`| string | Character used to quote SQL identifiers. Use `"\""` for ANSI standard or `` "`" `` for MySQL style. |
111
+
|`sql_dialect`| string | Optional statement-splitting dialect: `postgres`, `mysql`, `mssql`, `sqlite`, `oracle`, or `generic`. Oracle-like plugins, including DM/Dameng, should use `"oracle"`. |
110
112
|`alter_primary_key`| bool |`true` if the database supports altering primary keys after table creation. |
111
113
|`manage_tables`| bool |`true` to enable table and column management UI (Create Table, Add/Modify/Drop Column, Drop Table). Does not control index or FK operations. Defaults to `true`. |
112
114
|`readonly`| bool | When `true`, the driver is read-only: all data modification operations (INSERT, UPDATE, DELETE) are disabled in the UI. The add/delete row buttons, inline cell editing, and context menu edit actions are hidden. Table and column management is also hidden regardless of `manage_tables`. Defaults to `false`. |
@@ -640,8 +642,8 @@ Get column information for a table.
640
642
"name": "id",
641
643
"data_type": "INTEGER",
642
644
"is_nullable": false,
643
-
"column_default": null,
644
-
"is_primary_key": true,
645
+
"default_value": null,
646
+
"is_pk": true,
645
647
"is_auto_increment": true,
646
648
"comment": null
647
649
}
@@ -798,6 +800,61 @@ Get the SQL body of a stored routine.
798
800
799
801
---
800
802
803
+
### Triggers
804
+
805
+
Set `capabilities.triggers` to `true` when your driver implements the trigger RPCs. Tabularis uses this flag to show trigger-related UI.
0 commit comments