External Stored Procedure Manifest File | VantageCloud Lake - External Stored Procedure Manifest File - 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

When creating or replacing an external stored procedure in VantageCloud Lake, the External Routine Installation Tool tdextroutine uses the external stored procedure manifest file manifest.json to define the programming language properties and file details of the external stored procedure.

The manifest.json file has the following schema:
{ "manifest_version": string, 
"source_language": string, 
"parameter_spec": string, 
"parameter_style": string, 
"routine_kind": string, 
"glop_set_name": string, 
"sql_data_access": string, 
"external_data": string, 
"dynamic_result_sets": int, 
"sql_security": string, 
"files": [ 
   { "type": string, 
     "filepath": string, 
     "name_on_server": string, 
     "location": string, 
     "entry_point": string, 
     "jar_sql_id": string, 
     "replace_jar": boolean
    } 
  ] 
}

Manifest File Property Details

Property Description
manifest_version Required

The value must be "v1" for the manifest schema version.
source_language Required

The programming language in which the external stored procedure is written.

Allowed values for C, C++, and Java:
  • "C"
  • "CCP"
  • "JAVA"
parameter_spec List of input parameters for the external stored procedure in the format: “ParmName1 Data_Type, ParmName2 Data_Type,…"
parameter_style How parameters are passed to the external stored procedure. Allowed values:
  • "SQL"
  • "TD_GENERAL"
  • "JAVA"

Default is "SQL."
routine_kind Specifies the kind of external routine. Allowed values:
  • "REGULAR_FUNCTION"
  • "COMPRESS_UDF"
  • "DECOMPRESS_UDF"
glop_set_name Specifies the name of the GLOP set this procedure is associated with.
sql_data_access Specifies whether the external procedure body accesses the database or contains SQL statements. Allowed options:
  • "CONTAINS SQL"
  • "MODIFIES SQL DATA"
  • "READS SQL DATA"
  • "NO SQL"
external_data Determines whether the external stored procedure can read or modify data that is external to Vantage. Allowed options:
  • "MODIFIES EXTERNAL DATA"
  • "NO EXTERNAL DATA"
  • "READS EXTERNAL DATA"
dynamic_result_sets Specifies the number of dynamic result sets that can be returned.
sql_security The keyword you specify for privilege_option. It determines the privileges that VantageCloud Lake checks for the underlying objects specified in the request. Allowed values:
  • "CREATOR"
  • "DEFINER"
  • "INVOKER"
  • "OWNER"
files[n].filepage Required
Type of file. Allowed values:
  • "SOURCE"
  • "INCLUDE"
  • "OBJECT"
  • "PACKAGE"
  • "LIBRARY"
  • "JAR"
files[n].filepath The relative filepath including filename of a file within the .zip file that contains the files related to the external stored procedure. For example: sources/helpers/substr.c
files[n].name_on_server Required

The filename without file path or file extension to use when copying the file to the server’s compilation working directory. For example: substr
files[n].location Indicator that the file is located on the server or on the client. Allowed values:
  • "SERVER"
  • "CLIENT"

Default: "SERVER."

.
files[n].entry_point Name of the function within the source file that is the sole entry point for the external stored procedure.
files[n].jar_sql_id Name of the SQL identifier for the JAR file.
files[n].replace_jar

Set to true if a JAR file is already installed and needs to be replaced.

Default: false