15.10 - Requirements for Using the API - Teradata Database

Teradata Database Application Programming Reference

prodname
Teradata Database
vrm_release
15.10
category
Programming Reference
featnum
B035-1090-151K

PM/APIs

If you are using CLIv2, you must install CLIv2 on a client machine where the PM/API application is running.

If you are using the Teradata JDBC Driver, you must import the SQL Interface package and load the Teradata JDBC Driver. For complete instructions, see Teradata JDBC Driver Reference.

Open APIs (SQL Interfaces)

The SQL interfaces to workload management already exist if the following scripts have been run as part of Teradata installation:

  • For System PMPC and Teradata dynamic workload management SQL interfaces, you must run Database Initialization Program (DIP) utility and execute the DIPDEM and DIPTDWM scripts.
  • For the embedded services system functions, you must run the DIP utility and execute the DIPALL or DIPSYSFNC script. These scripts create the TD_SYSFNLIB database which should only be used by the system to support the embedded services functions. For more information about activating the embedded services system functions, see SQL Functions, Operators, Expressions, and Predicates.
  • For information about these DIP scripts, see Utilities.

    Required Privileges

    Each API described in this document, except for the MONITOR VERSION request and the embedded services system functions, has its own required privileges.

    Below are some examples of the required privileges.

  • To connect with the Teradata JDBC Driver, it is necessary that you are granted privileges for executing PM/API requests. For example, you must issue GRANT MONITOR TO guest before connecting as a guest user and executing any PM/API request.
  • To issue the ABORT SESSION and MONITOR SESSION requests, you must have the ABORTSESSION and MONSESSION privileges respectively as part of your default role or these privileges must be granted directly to you.
  • To issue the MONITOR AWT RESOURCE, MONITOR VIRTUAL RESOURCE, and MONITOR PHYSICAL RESOURCE requests, you must have the MONRESOURCE privilege as part of your default role or this privilege must be granted directly to you.
  • To access the UDFs and external stored procedures, the DBA must grant EXECUTE FUNCTION and EXECUTE PROCEDURE privileges to you. These privileges are not granted by default.
  • For more information on roles and privileges, see:

  • Database Administration
  • Security Administration
  • Teradata JDBC Driver User Guide
  • Related Topics

     

    For more information on ...

    See ...

    the different System PMPC PM/APIs and open APIs

    Chapter 4: “System PMPC APIs.”

    the different Teradata Dynamic Workload Management PM/APIs and open APIs

    Chapter 5: “Teradata Dynamic Workload Management APIs.”

    the different Query band PM/APIs and open APIs

    Chapter 6: “Query Band APIs.”

    the different embedded services system functions

    Chapter 7: “Embedded Services System APIs.”

    For more information about embedded services system functions, see SQL Functions, Operators, Expressions, and Predicates.

    how to code an application that uses the CLIv2 requests in this book

  • Teradata Call-Level Interface Version 2 Reference for Mainframe-Attached Systems
  • Teradata Call-Level Interface Version 2 Reference for Workstation-Attached Systems
  • using the Teradata JDBC Driver to access the Teradata Database

    Teradata JDBC Driver Reference.