Tools on MCP Toolbox for Databases

serverless-spark-get-batch

Mon, 01 Jan 0001 00:00:00 +0000

About

The serverless-spark-get-batch tool allows you to retrieve a specific Serverless Spark batch job.

serverless-spark-list-batches accepts the following parameters:

name: The short name of the batch, e.g. for projects/my-project/locations/us-central1/my-batch, pass my-batch.

The tool gets the project and location from the source configuration.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Serverless for Apache Spark

Example

kind: tool
name: get_my_batch
type: serverless-spark-get-batch
source: my-serverless-spark-source
description: Use this tool to get a serverless spark batch.

Output Format

The response contains the full Batch object as defined in the API spec, plus additional fields consoleUrl and logsUrl where a human can go for more detailed information.

serverless-spark-get-session-template

Mon, 01 Jan 0001 00:00:00 +0000

About

A serverless-spark-get-session-template tool retrieves a specific Spark session template from a Google Cloud Serverless for Apache Spark source.

serverless-spark-get-session-template accepts the following parameters:

name (required): The short name of the session template, e.g. for projects/my-project/locations/us-central1/sessionTemplates/my-session-template, pass my-session-template.

The tool gets the project and location from the source configuration.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Serverless for Apache Spark

Example

kind: tool
name: get_spark_session_template
type: serverless-spark-get-session-template
source: my-serverless-spark-source
description: Use this tool to get details of a serverless spark session template.

Output Format

{
 "sessionTemplate": { 
 "name": "projects/my-project/locations/us-central1/sessionTemplates/my-session-template",
 "description": "Template for Spark Session",
 // ... complete session template resource definition
 }
}

Reference

field	type	required	description
type	string	true	Must be “serverless-spark-get-session-template”.
source	string	true	Name of the source the tool should use.
description	string	true	Description of the tool that is passed to the LLM.
authRequired	string[]	false	List of auth services required to invoke this tool

serverless-spark-list-batches

Mon, 01 Jan 0001 00:00:00 +0000

About

A serverless-spark-list-batches tool returns a list of Spark batches from a Google Cloud Serverless for Apache Spark source.

serverless-spark-list-batches accepts the following parameters:

filter (optional): A filter expression to limit the batches returned. Filters are case sensitive and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, create_time, and labels. For example: state = RUNNING AND create_time < "2023-01-01T00:00:00Z".
pageSize (optional): The maximum number of batches to return in a single page.
pageToken (optional): A page token, received from a previous call, to retrieve the next page of results.

The tool gets the project and location from the source configuration.

serverless-spark-cancel-batch

Mon, 01 Jan 0001 00:00:00 +0000

About

serverless-spark-cancel-batch tool cancels a running Spark batch operation in a Google Cloud Serverless for Apache Spark source. The cancellation request is asynchronous, so the batch state will not change immediately after the tool returns; it can take a minute or so for the cancellation to be reflected.

serverless-spark-cancel-batch accepts the following parameters:

operation (required): The name of the operation to cancel. For example, for projects/my-project/locations/us-central1/operations/my-operation, you would pass my-operation.

The tool inherits the project and location from the source configuration.

serverless-spark-create-pyspark-batch

Mon, 01 Jan 0001 00:00:00 +0000

About

A serverless-spark-create-pyspark-batch tool submits a Spark batch to a Google Cloud Serverless for Apache Spark source. The workload executes asynchronously and takes around a minute to begin executing; status can be polled using the get batch tool.

serverless-spark-create-pyspark-batch accepts the following parameters:

mainFile: The path to the main Python file, as a gs://… URI.
args Optional. A list of arguments passed to the main file.
version Optional. The Serverless runtime version to execute with.

Compatible Sources

This tool can be used with the following database sources:

serverless-spark-create-spark-batch

Mon, 01 Jan 0001 00:00:00 +0000

About

A serverless-spark-create-spark-batch tool submits a Java Spark batch to a Google Cloud Serverless for Apache Spark source. The workload executes asynchronously and takes around a minute to begin executing; status can be polled using the get batch tool.

serverless-spark-create-spark-batch accepts the following parameters:

mainJarFile: Optional. The gs:// URI of the jar file that contains the main class. Exactly one of mainJarFile or mainClass must be specified.
mainClass: Optional. The name of the driver’s main class. Exactly one of mainJarFile or mainClass must be specified.
jarFiles: Optional. A list of gs:// URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
args Optional. A list of arguments passed to the driver.
version Optional. The Serverless runtime version to execute with.

Compatible Sources

This tool can be used with the following database sources: