alloydb-omni-data

Files (9)

• SKILL.md
• execute_sql.js · scripts/
• list_indexes.js · scripts/
• list_schemas.js · scripts/
• list_sequences.js · scripts/
• list_stored_procedure.js · scripts/
• list_tables.js · scripts/
• list_triggers.js · scripts/
• list_views.js · scripts/

SKILL.md (first lines)

## Usage

All scripts can be executed using Node.js. Replace `<param_name>` and
`<param_value>` with actual values.

**Bash:** `node <skill_dir>/scripts/<script_name>.js '{"<param_name>":
"<param_value>"}'`

**PowerShell:** `node <skill_dir>/scripts/<script_name>.js '{\"<param_name>\":
\"<param_value>\"}'`

Note: The scripts automatically load the environment variables from various .env
files. Do not ask the user to set vars unless skill executions fails due to env
var absence.

## Scripts

### execute_sql

Use this skill to execute a single SQL statement.

#### Parameters

Name | Type   | Description         | Required | Default
:--- | :----- | :------------------ | :------- | :------
sql  | string | The sql to execute. | Yes      |
 

--------------------------------------------------------------------------------

### list_indexes

Lists available user indexes in the database, excluding system schemas
(pg_catalog, information_schema). For each index, the following properties are
returned: schema name, table name, index name, index type (access method), a
boolean indicating if it's a unique index, a boolean indicating if it's for a
primary key, the index definition, index size in bytes, the number of index
scans, the number of index tuples read, the number of table tuples fetched via
index scans, and a boolean indicating if the index has been used at least once.

#### Parameters

| Name        | Type    | Description                     | Required | Default |
| :---------- | :------ | :------------------------------ | :------- | :------ |
| schema_name | string  | Optional: A text to filter      | No       |         |
:             :         : results by schema name. The     :          :         :
:             :         : input is used within a LIKE     :          :         :
:             :         : clause.                         :          :         :
| table_name  | string  | Optional: A text to filter      | No       |         |
:             :         : results by table name. The      :          :         :
:             :         : input is used within a LIKE     :          :         :
:             :         : clause.                         :          :         :
| index_name  | string  | Optional: A text to filter      | No       |         |
:             :         : results by index name. The      :          :         :
:             :         : input is used within a LIKE     :          :         :
:             :         : clause.                         :          :         :
| only_unused | boolean | Optional: If true, only returns | No       | `false` |
:             :         : indexes that have never been    :          :         :
:             :         : used.                           :          :         :
| limit       | integer | Optional: The maximum number of | No       | `50`    |
:             :         : rows to return. Default is 50   :          :         :

--------------------------------------------------------------------------------

### list_schemas

Lists all schemas in the database ordered by schema name and excluding system
and temporary schemas. It returns the schema name, schema owner, grants, number
of functions, number of tables and number of views within each schema.

#### Parameters

| Name        | Type    | Description                     | Required | Default |
| :---------- | :------ | :------------------------------ | :------- | :------ |
| schema_name | string  | Optional: A specific schema     | No       |         |
:             :         : name pattern to search for.     :          :         :
| owner       | string  | Optional: A specific schema     | No       |         |
:             :         : owner name pattern to search    :          :         :
:             :         : for.                            :          :         :
| limit       | integer | Optional: The maximum number of | No       | `10`    |
:             :         : schemas to return.              :          :         :

--------------------------------------------------------------------------------

### list_sequences

Lists sequences in the database. Returns sequence name, schema name, sequence
owner, data type of the sequence, starting value, minimum value, maximum value
of the sequence, the value by which the sequence is incremented, and the last
value generated by the sequence in the current session

#### Parameters

| Name          | Type    | Description                   | Required | Default |
| :------------ | :------ | :---------------------------- | :------- | :------ |
| schema_name   | string  | Optional: A specific schema   | No       |         |
:               :         : name pattern to search for.   :          :         :
| sequence_name | string  | Optional: A specific sequence | No       |         |
:               :         : name pattern to search for.   :          :         :
| limit         | integer | Optional: The maximum number  | No       | `50`    |
:               :         : of rows to return. Default is :          :         :
:               :         : 50                            :          :         :

--------------------------------------------------------------------------------

### list_stored_procedure

Retrieves stored procedure metadata returning schema name, procedure name,
procedure owner, language, definition, and description, filtered by optional
role name (procedure owner), schema name, and limit (default 20).

#### Parameters

| Name        | Type    | Description                     | Required | Default |
| :---------- | :------ | :------------------------------ | :------- | :------ |
| role_name   | string  | Optional: The owner name to     | No       |         |
:             :         : filter the stored procedures    :          :         :
:             :         : by. Defaults to NULL.           :          :         :
| schema_name | string  | Optional: The schema name to    | No       |         |

From jsoehner/skills-backup, Apache-2.0.

More from jsoehner/skills-backup