diff --git a/docs/en/reference/prebuilt-tools.md b/docs/en/reference/prebuilt-tools.md index 7a52236dfa..a1319e7408 100644 --- a/docs/en/reference/prebuilt-tools.md +++ b/docs/en/reference/prebuilt-tools.md @@ -44,6 +44,12 @@ See [Usage Examples](../reference/cli.md#examples). * **Tools:** * `execute_sql`: Executes a SQL query. * `list_tables`: Lists tables in the database. + * `list_active_queries`: Lists ongoing queries. + * `list_available_extensions`: Discover all PostgreSQL extensions available for installation. + * `list_installed_extensions`: List all installed PostgreSQL extensions. + * `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit. + * `list_locks`: Identifies all locks held by active processes. + * `replication_stats`: Lists each replica's process ID and sync state. * `list_autovacuum_configurations`: Lists autovacuum configurations in the database. * `list_memory_configurations`: Lists memory-related configurations in the @@ -59,12 +65,16 @@ See [Usage Examples](../reference/cli.md#examples). * `list_triggers`: Lists triggers in the database. * `list_indexes`: List available user indexes in a PostgreSQL database. * `list_sequences`: List sequences in a PostgreSQL database. + * `list_query_stats`: Lists query statistics. + * `get_column_cardinality`: Gets column cardinality. + * `list_table_stats`: Lists table statistics. * `list_publication_tables`: List publication tables in a PostgreSQL database. * `list_tablespaces`: Lists tablespaces in the database. * `list_pg_settings`: List configuration parameters for the PostgreSQL server. * `list_database_stats`: Lists the key performance and activity statistics for each database in the AlloyDB instance. * `list_roles`: Lists all the user-created roles in PostgreSQL database. + * `list_stored_procedure`: Lists stored procedures. ## AlloyDB Postgres Admin @@ -113,6 +123,12 @@ See [Usage Examples](../reference/cli.md#examples). * **Tools:** * `execute_sql`: Executes a SQL query. * `list_tables`: Lists tables in the database. + * `list_active_queries`: Lists ongoing queries. + * `list_available_extensions`: Discover all PostgreSQL extensions available for installation. + * `list_installed_extensions`: List all installed PostgreSQL extensions. + * `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit. + * `list_locks`: Identifies all locks held by active processes. + * `replication_stats`: Lists each replica's process ID and sync state. * `list_autovacuum_configurations`: Lists autovacuum configurations in the database. * `list_columnar_configurations`: List AlloyDB Omni columnar-related configurations. @@ -130,12 +146,16 @@ See [Usage Examples](../reference/cli.md#examples). * `list_triggers`: Lists triggers in the database. * `list_indexes`: List available user indexes in a PostgreSQL database. * `list_sequences`: List sequences in a PostgreSQL database. + * `list_query_stats`: Lists query statistics. + * `get_column_cardinality`: Gets column cardinality. + * `list_table_stats`: Lists table statistics. * `list_publication_tables`: List publication tables in a PostgreSQL database. * `list_tablespaces`: Lists tablespaces in the database. * `list_pg_settings`: List configuration parameters for the PostgreSQL server. * `list_database_stats`: Lists the key performance and activity statistics for each database in the AlloyDB instance. * `list_roles`: Lists all the user-created roles in PostgreSQL database. + * `list_stored_procedure`: Lists stored procedures. ## BigQuery @@ -173,6 +193,21 @@ See [Usage Examples](../reference/cli.md#examples). * `list_table_ids`: Lists tables. * `search_catalog`: Search for entries based on the provided query. +## ClickHouse + +* `--prebuilt` value: `clickhouse` +* **Environment Variables:** + * `CLICKHOUSE_HOST`: The hostname or IP address of the ClickHouse server. + * `CLICKHOUSE_PORT`: The port number of the ClickHouse server. + * `CLICKHOUSE_USER`: The database username. + * `CLICKHOUSE_PASSWORD`: The password for the database user. + * `CLICKHOUSE_DATABASE`: The name of the database to connect to. + * `CLICKHOUSE_PROTOCOL`: The protocol to use (e.g., http). +* **Tools:** + * `execute_sql`: Use this tool to execute SQL. + * `list_databases`: Use this tool to list all databases in ClickHouse. + * `list_tables`: Use this tool to list all tables in a specific ClickHouse database. + ## Cloud SQL for MySQL * `--prebuilt` value: `cloud-sql-mysql` @@ -270,6 +305,12 @@ See [Usage Examples](../reference/cli.md#examples). * **Tools:** * `execute_sql`: Executes a SQL query. * `list_tables`: Lists tables in the database. + * `list_active_queries`: Lists ongoing queries. + * `list_available_extensions`: Discover all PostgreSQL extensions available for installation. + * `list_installed_extensions`: List all installed PostgreSQL extensions. + * `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit. + * `list_locks`: Identifies all locks held by active processes. + * `replication_stats`: Lists each replica's process ID and sync state. * `list_autovacuum_configurations`: Lists autovacuum configurations in the database. * `list_memory_configurations`: Lists memory-related configurations in the @@ -285,12 +326,16 @@ See [Usage Examples](../reference/cli.md#examples). * `list_triggers`: Lists triggers in the database. * `list_indexes`: List available user indexes in a PostgreSQL database. * `list_sequences`: List sequences in a PostgreSQL database. + * `list_query_stats`: Lists query statistics. + * `get_column_cardinality`: Gets column cardinality. + * `list_table_stats`: Lists table statistics. * `list_publication_tables`: List publication tables in a PostgreSQL database. * `list_tablespaces`: Lists tablespaces in the database. * `list_pg_settings`: List configuration parameters for the PostgreSQL server. * `list_database_stats`: Lists the key performance and activity statistics for each database in the postgreSQL instance. * `list_roles`: Lists all the user-created roles in PostgreSQL database. + * `list_stored_procedure`: Lists stored procedures. ## Cloud SQL for PostgreSQL Observability @@ -336,6 +381,7 @@ See [Usage Examples](../reference/cli.md#examples). * `create_user`: Creates a new user in a Cloud SQL instance. * `wait_for_operation`: Waits for a Cloud SQL operation to complete. * `clone_instance`: Creates a clone for an existing Cloud SQL for PostgreSQL instance. + * `postgres_upgrade_precheck`: Performs a precheck for a major version upgrade of a Cloud SQL for PostgreSQL instance. * `create_backup`: Creates a backup on a Cloud SQL instance. * `restore_backup`: Restores a backup of a Cloud SQL instance. @@ -420,6 +466,15 @@ See [Usage Examples](../reference/cli.md#examples). * `search_aspect_types`: Finds aspect types relevant to the query. +## Elasticsearch + +* `--prebuilt` value: `elasticsearch` +* **Environment Variables:** + * `ELASTICSEARCH_HOST`: The hostname or IP address of the Elasticsearch server. + * `ELASTICSEARCH_APIKEY`: The API key for authentication. +* **Tools:** + * `execute_esql_query`: Use this tool to execute ES|QL queries. + ## Firestore * `--prebuilt` value: `firestore` @@ -537,6 +592,19 @@ See [Usage Examples](../reference/cli.md#examples). * `execute_sql`: Executes a SQL query. * `list_tables`: Lists tables in the database. +## MindsDB + +* `--prebuilt` value: `mindsdb` +* **Environment Variables:** + * `MINDSDB_HOST`: The hostname or IP address of the MindsDB server. + * `MINDSDB_PORT`: The port number of the MindsDB server. + * `MINDSDB_DATABASE`: The name of the database to connect to. + * `MINDSDB_USER`: The database username. + * `MINDSDB_PASS`: The password for the database user. +* **Tools:** + * `mindsdb-execute-sql`: Execute SQL queries directly on MindsDB database. + * `mindsdb-sql`: Execute parameterized SQL queries on MindsDB database. + ## MySQL * `--prebuilt` value: `mysql` @@ -592,6 +660,12 @@ See [Usage Examples](../reference/cli.md#examples). * **Tools:** * `execute_sql`: Executes a SQL query. * `list_tables`: Lists tables in the database. + * `list_active_queries`: Lists ongoing queries. + * `list_available_extensions`: Discover all PostgreSQL extensions available for installation. + * `list_installed_extensions`: List all installed PostgreSQL extensions. + * `long_running_transactions`: Identifies and lists database transactions that exceed a specified time limit. + * `list_locks`: Identifies all locks held by active processes. + * `replication_stats`: Lists each replica's process ID and sync state. * `list_autovacuum_configurations`: Lists autovacuum configurations in the database. * `list_memory_configurations`: Lists memory-related configurations in the @@ -607,12 +681,16 @@ See [Usage Examples](../reference/cli.md#examples). * `list_triggers`: Lists triggers in the database. * `list_indexes`: List available user indexes in a PostgreSQL database. * `list_sequences`: List sequences in a PostgreSQL database. + * `list_query_stats`: Lists query statistics. + * `get_column_cardinality`: Gets column cardinality. + * `list_table_stats`: Lists table statistics. * `list_publication_tables`: List publication tables in a PostgreSQL database. * `list_tablespaces`: Lists tablespaces in the database. * `list_pg_settings`: List configuration parameters for the PostgreSQL server. * `list_database_stats`: Lists the key performance and activity statistics for each database in the PostgreSQL server. * `list_roles`: Lists all the user-created roles in PostgreSQL database. + * `list_stored_procedure`: Lists stored procedures. ## Google Cloud Serverless for Apache Spark @@ -627,6 +705,38 @@ See [Usage Examples](../reference/cli.md#examples). view serverless batches. * **Tools:** * `list_batches`: Lists Spark batches. + * `get_batch`: Gets information about a Spark batch. + * `cancel_batch`: Cancels a Spark batch. + * `create_pyspark_batch`: Creates a PySpark batch. + * `create_spark_batch`: Creates a Spark batch. + +## SingleStore + +* `--prebuilt` value: `singlestore` +* **Environment Variables:** + * `SINGLESTORE_HOST`: The hostname or IP address of the SingleStore server. + * `SINGLESTORE_PORT`: The port number of the SingleStore server. + * `SINGLESTORE_DATABASE`: The name of the database to connect to. + * `SINGLESTORE_USER`: The database username. + * `SINGLESTORE_PASSWORD`: The password for the database user. +* **Tools:** + * `execute_sql`: Use this tool to execute SQL. + * `list_tables`: Lists detailed schema information for user-created tables. + +## Snowflake + +* `--prebuilt` value: `snowflake` +* **Environment Variables:** + * `SNOWFLAKE_ACCOUNT`: The Snowflake account. + * `SNOWFLAKE_USER`: The database username. + * `SNOWFLAKE_PASSWORD`: The password for the database user. + * `SNOWFLAKE_DATABASE`: The name of the database to connect to. + * `SNOWFLAKE_SCHEMA`: The schema name. + * `SNOWFLAKE_WAREHOUSE`: The warehouse name. + * `SNOWFLAKE_ROLE`: The role name. +* **Tools:** + * `execute_sql`: Use this tool to execute SQL. + * `list_tables`: Lists detailed schema information for user-created tables. ## Spanner (GoogleSQL dialect)