tdextroutine External Stored Procedures Subcommands/Options | VantageCloud Lake - tdextroutine External Stored Procedure Subcommands and Options - Teradata Vantage

Teradata® VantageCloud Lake
Deployment
VantageCloud
Edition
Lake
Product
Teradata Vantage
Published
January 2023
ft:locale
en-US
ft:lastEdition
2024-12-11
dita:mapPath
phg1621910019905.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
phg1621910019905
The External Routine Installation Tool (tdextroutine) provides subcommands to create or manage C/C++ and Java external stored procedures in VantageCloud Lake:
  • Create an external stored procedure
  • Replace an existing external stored procedure
  • List existing external stored procedures
  • Get details about an external stored procedure
  • Delete an external stored procedure JAR file
  • Redistribute an external stored procedure JAR file
  • Drop an external stored procedure

xsp create OPTIONS XSP_NAME

Creates an external stored procedure.

xsp create [OPTIONS] XSP_NAME

XSP_NAME is a required argument that defines the name of the external stored procedure as used in query statements.

Use tdextroutine xsp create --help to display the options for the subcommand. The options are listed in the following table:
Option Type Description
--database, -d TEXT Creates the external stored procedure in the specified database. If this option is omitted, the default database of the user is used.
--source_path, -s DIRPATH Path to the directory containing the external stored procedure manifest.json file.

The artifact .zip file will be generated based on the manifest file.
--artifact_path, -a FILEPATH Path to the artifact .zip file.
--artifact_id, -i TEXT Artifact ID of the previously uploaded artifact file.

xsp replace OPTIONS XSP_NAME

Creates an external stored procedure or replaces an existing external stored procedure. The options for xsp replace are the same as for xsp create.

xsp replace [OPTIONS] XSP_NAME

xsp list OPTIONS

Lists the existing external stored procedures in an environment.

Use tdextroutine xsp list --help to display the available options for the xsp list subcommand. The options are listed in the following table.
Option Type Description
--database, -d TEXT Filters results using database name.
--xsp_name, -x TEXT Filters results using xsp_name.

xsp fetch XSP_ID

Fetches details about an existing external stored procedure.

XSP_ID is a required argument that defines the identifier of the external stored procedure as returned by the xsp create subcommand or in the results of the xsp list subcommand.

udf redistribute-jar Options jar_name

Redistributes a Java external stored procedure JAR file that was previously registered with the database. jar_name is required and specifies the name of the JAR file provided in the external stored procedure manifest file.
This subcommand is used for redistributing the JAR associated with Java external stored procedures as well as Java UDFs from the database.
Option Type Description
--database, -d TEXT If this option is omitted, then the default database of the user is used.

udf remove-jar [Options] jar_name

Deletes the JAR file associated with a Java external stored procedure from the database.jar_name is required and specifies the name of the JAR file provided in the external stored procedure manifest file.
This subcommand is used for removing the JAR associated with Java external stored procedures as well as Java UDFs from the database.
Option Type Description
--database, -d TEXT If this option is omitted, then the default database of the user is used.

xsp drop [Options] XSP_ID

Drops an existing external stored procedure.

XSP_ID is an optional argument that defines the identifier of the external stored procedure as returned by the xsp create subcommand or in the results of the xsp list subcommand.

Available options are listed in the following table.

Option Type Description
--database, -d TEXT Drops the external stored procedure in the specified database. If this option is omitted, then the default database of the user is used.
--xsp_name, -x TEXT Drops the external stored procedure with the specified name.