Teradata VantageCloud Lake | Third Party Applications | Installing Protegrity - Installing Protegrity Application for VantageCloud Lake - Teradata Vantage
Teradata® VantageCloud Lake
Deployment
VantageCloud
Edition
Lake
Product
Teradata Vantage
Published
January 2023
Language
English (United States)
Last Update
2024-10-18
dita:mapPath
phg1621910019905.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
phg1621910019905
What's New
September 2024
August 2024
June 2024
Previous Releases
May 2024
April 2024
March 2024
February 2024
January 2024
2023 Releases
November 2023
October 2023
September 2023
August 2023
July 2023
May 2023
March 2023
February 2023
January 2023
Getting Started: First Sign On by Organization Admin
What You Need before Starting
Step 1: Signing On and Creating Your First Environment
AWS: Creating a Customer Managed Encryption Key
Azure: Creating a Customer Managed Encryption Key
Azure: Rotating the Encryption Key
Step 2: Setting the Environment Connection Type
Setting Up an Internet Connection
Setting Private Link for Azure
Setting PrivateLink for AWS
Creating Endpoints
Setting Private Link (Private Service Connect) for Google Cloud
Step 3: Creating Compute Groups
Creating Users Using the Console
Quick Reference for Database Administrator Tasks
Creating the Database Administrator SYSDBA
Creating Databases
Creating Profiles and Roles
Creating Database Users
Introduction to VantageCloud Lake
Teradata Vantage
VantageCloud Lake Organizations and Environments
VantageCloud Lake Architecture
Analytics Database
Primary Cluster
Primary Cluster Storage
Variable AMPs per Instance for Primary Cluster
AMPs per Instance (AWS)
AMPs per Instance (Azure)
AMPs per Instance (Google Cloud)
Scaling the Primary Cluster Up and Down
Compute Clusters
Data Storage Options
Life of a Query
Running the Query
Language Support
Internationalization (I18n) and Localization (L10n) Limitations
Client Character Set Support on Primary Cluster
Analytics Capabilities
Automatic Upgrades
VantageCloud Lake on Google Cloud
Compatibility Matrix for VantageCloud Lake Ecosystem Applications
Ecosystem Applications
Teradata Tools and Utilities
Database Utilities
Teradata Vantage Restricted Words
Database User Types and Roles
Teradata Support
VantageCloud Lake Use Cases
Managing Access
Adding an Identity Provider
Setting Up Single Sign-on
Configuring an Identity Provider
Creating Realms
Associating Realms with Environments
Creating a Personal Access Token
Enabling Anaconda for Open Analytics
Setting Up an Environment Connection
Setting Up an Internet Connection
Setting PrivateLink for AWS
Creating Endpoints
Setting Private Link for Azure
Setting Private Link (Private Service Connect) for Google Cloud
Managing Users
User Planning
User Privileges
Using the Console to Create and Manage Users
Viewing Existing Users, Roles, and Compute Groups Using the Console
Creating Users Using the Console
Editing an Existing User Using the Console
Deleting a User Using the Console
Revoking the Token for a User Using the Console
Using SQL to Create and Manage Users
Creating Database Administrators Using SQL
Granting Access to Compute Groups Using SQL
Creating Users Using SQL
Creating Compute Cluster Administrators Using SQL
Making Changes to Existing User Privileges Using SQL
Giving Users Access to VantageCloud Lake Using SQL
Revoking User Access to VantageCloud Lake Using SQL
Revoking VantageCloud Lake User Privileges Using SQL
Dropping a User Using SQL
Working with Users, Roles, and Profiles: Operational DBAs
Overview of Establishing Users
Types of Users
Assessing Database User Needs
Best Practices for Creating Users
Creating User Accounts
Determining Account for User Session
Creating User Profiles
Use of Profiles
Precedence of Values for Profile Parameters
Creating Profiles
Dropping Profiles
Working with Database Users
Creating Database Users
Creating Temporary Passwords for First Login
Using Roles to Manage User Privileges
User Types and Minimum Required Privileges
Types of Privileges
Limitations on Using Roles
Create User Roles
When to Grant Privileges to a Role
Granting Privileges to a Role
Granting User Membership in a Role
Dropping a Role
Defining the Default Role for a User
Assigning the Default Role
Dropping the Default Role
Granting Privileges Directly to Users
Granting Privileges to Users Prerequisites
Example: Granting Privileges on Sys_Calendar to All Users
Granting Privileges to a User
Automatic Privileges for Creators
Automatic Privileges for Created Users and Databases
Granting Privileges to Users Related Information
Setting Up Compute Cluster Roles, Compute Profiles, and Compute Groups and Allowing Users Access
Compute Maps
CREATE COMPUTE GROUP: SQL
Creating Compute Profiles
Creating Compute Cluster Roles
Granting Users Access to Compute Groups
Managing Environments
Increasing Availability with Multi-Node Cliques (AWS)
Creating an Environment: Organization Admin
AWS: Creating a Customer Managed Encryption Key
Azure: Creating a Customer Managed Encryption Key
Connecting to an Environment
Compute Groups
Creating a Compute Group: Console
Managing the Organization
Creating Organization Admins
Removing Organization Admins
Managing Compute Resources
Which Components Your Database Needs
Compute Clusters
Standard Compute Clusters
Analytic Compute Clusters
Compute Groups
Compute Profiles
Use Cases for Compute Clusters
Example: Schedule a Small Compute Cluster for 5:00 PM - 8:00 AM and a Large Compute Cluster for 8:00 AM - 5:00 PM
Example: Schedule a Compute Cluster for Monday-Friday 8:00 AM - 5:00 PM
Example: Compute Group and Compute Profiles for Core Production Department
Example: Compute Group and Compute Profile for Departmentally Controlled Environment
Compute Cluster Administrators
Creating Compute Cluster Administrators
Creating a Compute Group
Creating a Compute Group: Console
CREATE COMPUTE GROUP: SQL
Creating a Compute Profile
Giving Other Users Access to a Compute Group
Suspending and Resuming a Compute Profile
Review Consumption Usage
Viewing and Configuring Consumption Alerts
Loading Data
Introduction to Flow
Schema Inference
Using Flow from the VantageCloud Lake Console
Finding Flows on the Console
Creating a Flow Using the Console (AWS)
Giving Flow Access to Your AWS S3 Resources
IAM Policy Template
Trusted Entity Policy Template
Creating a Flow Using the Console (Azure)
Flow Advanced Use Cases
Microbatch Tuning
Schema Hints
Creating a Flow to Another Database
Monitoring a Flow Using the Console
VantageCloud Lake Flow Troubleshooting
Recoverable and Unrecoverable Errors
Error Tables for Capturing Data Incompatibility
Flow Problems and Workarounds
Use Cases: Loading Data Using TPT, ODBC, JDBC, or QueryGrid
Accessing External Object Storage Using Native Object Store
Load Troubleshooting and Error Handling for Native Object Store
Loading Data from External Object Storage Using Native Object Store
Loading and Accessing Data Using SQL
INSERT-SELECT Statement
INSERT Statement
DELETE Statement
UPDATE Statement
Querying Object File System Data
Managing Consumption
Using the Consumption Estimates
Third Party Applications
Protegrity
Installation Considerations for Protegrity ESA Server
Setting Up the AWS PrivateLink Service
Installing Protegrity Application for VantageCloud Lake
Viewing Details and Updating Protegrity Application
Uninstalling Protegrity Application
SAS
Installing SAS Application for VantageCloud Lake
Uninstalling SAS Application
Data Copy
Key Concepts
Enabling Data Copy Service
Prerequisites to Enable Data Copy
Using Data Copy Service
Creating Copy Plan
Managing Copy Plan
Managing Admin Tasks
Configuring Copy Manager
Editing Copy Manager
Configuring Copy Agent
Editing Copy Agent
Troubleshooting Data Copy
Sharing Data
Key Concepts
Getting Started
Managing Data Shares
Creating Data Shares
Working with Datasets
Adding Datasets
Managing Datasets
Viewing and Using Datasets
Managing Subscribers to Data Shares
Adding Users
Adding Roles
Removing Users
Removing Roles
Editing Data Share
Validating Data Shares
Deleting a Data Share
Limitations and Trade-Offs
Data Storage
Object Storage
Object File System
Object File System Overview and Benefits
Object File System Considerations
OFS Scheduler
Tables and Views for OFS Scheduler
Columns in JobTbl Table
Columns in HistoryTbl Table
Managing Object File System Storage Access
Change the Default Storage
ALTER STORAGE ACCESS Syntax
ALTER STORAGE ACCESS Usage
Managing an Object File System Table
Creating an Object File System Table
CREATE TABLE with STORAGE Option Syntax
CREATE TABLE with STORAGE Option Usage
Examples: CREATE TABLE with STORAGE Option
Removing an Object File System Table
Showing an Object File System Table
Example: Show an Object File System Table
Example: Show an Object File System Columnar Table
Reorganizing Object File System Tables for Performance
Object File System Table Restrictions
Limitations Using Indexes with Object File System Tables
Primary Index
Secondary Index
Join Index
External Object Storage Accessed Using Native Object Store (NOS)
Authorization to Access External Object Storage
Block Storage
Open Table Format Datalakes
Supported Software for Datalakes
Running and Monitoring Queries
Creating and Running Queries
Creating a Single Statement or Script
Running an Existing Statement or Script
Using the Simple Query Builder
Visualizing Data
Launching Visualization
Results Tab
Charts Tab
Monitoring and Managing Queries
Summary View
Query Monitoring
Detail View
Query Breakdown
Overview Tab
SQL Tab
Explain Tab
Skew Tab
Query Band Tab
Creating and Configuring Reports
Managing Reports
System Defined Reports
Managing Your Workloads
Workload Management Priorities
Defining System Throttle or System Filter Rules
Analyzing Your Data
Build Scalable Analytics with Open Analytics Framework
Introduction to Vantage Open Analytics
A Historical Perspective of Python and R in Teradata
What is Open Analytics Framework
Why Use Open Analytics Framework
When to Use Open Analytics Framework
How Open Analytics Framework Works
Requisite Tools and Libraries
Requisite Input and Output Structures
Data Science Workflows using Open Analytics Framework
Setting Up VantageCloud Lake for Open Analytics
Creation and Management of Analytic Compute Groups
User Profile
User Sessions
User Environments
Overview of APIs for User Environment Operations
Anaconda Integration
Enabling Anaconda for Open Analytics
Open Analytics Python conda User Environment
APPLY Table Operator
Sample Use Cases in Open Analytics Framework
Prerequisites for All Use Cases
Use Cases using Python Environments
Bank Marketing Model Training and Prediction
Setting up and Managing User Environment
Loading Dataset and Preparing for Training
Python Training Script
Run the Bank Marketing Training
Scoring the Prediction Model
Cleaning Up
Scoring with an Externally Trained Model File
Setting Up and Managing the User Environment
Installing Model and Python Script Files
Scoring the Predictive Model with APPLY Table Operator
Cleaning Up
Training and Scoring Multiple Micro Models for Each Partition
Setting Up and Managing the User Environment
Load Data for Training
Start the Model Training
Deploy the Model In the User Environment
Cleaning Up
K-Means Clustering Classification
Setting Up and Managing the User Environment
Installing Python Script File
Running Clustering Analysis with APPLY Table Operator
Cleaning up
Simulation
Setting Up and Managing the User Environment
Installing the Python Script File
Running Simulation Analysis with APPLY Table Operator
Cleaning Up
Examples with teradataml.DataFrame.apply Method
Setting Up and Managing the User Environment
Example 1: Removing Stopwords from Text
Example 2: Normalizing Data
Cleaning Up
Use Cases using Python Conda Environments
Predicting Next Value Using Keras
Setting Up and Managing the User Environment
Installing Python Script Files
Running Keras Script with APPLY Table Operator
Cleaning Up
Sentiment Analysis
Setting Up and Managing the User Environment
Installing Python Script Files
Running Sentiment Analysis with APPLY Table Operator
Cleaning Up
Use Cases using R Environments
Gradient Boosting
Setting Up and Managing the User Environment
Installing R Script Files
Running Gradient Boosting Algorithm with APPLY Table Operator
Cleaning Up
Natural Language Processing
Setting Up and Managing the User Environment
Installing R Script Files
Tokenizing the Text with APPLY Table Operator
Cleaning Up
Combining Multidimensional Arrays
Setting Up and Managing the User Environment
Installing R Script Files
Combining Multidimensional Arrays with APPLY Table Operator
Cleaning Up
Additional Information and Best Practice Tips
Converting Scripts to Use with Open Analytics Framework
Best Practice Tips
Optimal Use Cases
Use Cases Dos and Don'ts
System Resources - Memory
Preventing Unwanted Output
Production Deployment
Troubleshooting
API Integration Guide for Cloud Machine Learning
Teradata Partner API
Welcome to Teradata API Integration
Key Feature Additions and Changes
Azure Machine Learning
Software Compatibility and Dependencies
Getting Ready to Use Teradata API Integration for Azure Machine Learning
Azure Machine Learning Endpoints
API_Request In-database Function
API_Request In-database Function Installation
API_Request In-database Function Syntax
API_Request In-database Function Syntax Elements
API_Request In-database Function Input
API_Request In-database Function Output Schema
API_Request In-database Function Usage
teradataml Extension
create_tdapi_context Method
remove_tdapi_context Method
TDApiClient Class
fit() Method - Training Azure Machine Learning Model
deploy() Method - Deploying Azure Machine Learning Model
TDAzurePredictor.predict Method
TDAzurePredictor.from_predictor Method
BYOMPredictor Class
BYOMPredictor.predict Method
TDApiClient.API_Request
Use Cases
Google Vertex AI
Software Compatibility and Dependencies
Getting Ready to Use Teradata API Integration for Google Vertex AI
Google Vertex AI Endpoints
API_Request In-database Function
API_Request In-database Function Installation
API_Request In-database Function Syntax
API_Request In-database Function Syntax Elements
API_Request In-database Function Input
API_Request In-database Function Output Schema
API_Request In-database Function Usage
teradataml Extension
create_tdapi_context Method
remove_tdapi_context Method
TDApiClient Class
TrainingJob.fit Method
TrainingJob.deploy Method
TDApiClient.API_Request
Use Cases
OpenAI and Azure OpenAI
Software Compatibility and Dependencies
Getting Ready to Use Teradata API Integration with OpenAI or Azure OpenAI
API_Request In-database Function
API_Request In-database Function Installation
API_Request In-database Function Syntax
API_Request In-database Function Syntax Elements
API_Request In-database Function Input
API_Request In-database Function Output Schema
API_Request In-database Function Usage
teradataml Extension
TDApiClient.API_Request
Use Cases
Amazon Bedrock
Software Compatibility and Dependencies
Getting Ready to Use Teradata API Integration with Amazon Bedrock
Amazon Bedrock Endpoints
API_Request In-database Function
API_Request In-database Function Installation
API_Request In-database Function Syntax
API_Request In-database Function Syntax Elements
API_Request In-database Function Input
API_Request In-database Function Output Schema
API_Request In-database Function Usage
teradataml Extension
TDApiClient.API_Request
Example Prerequisites
Teradata Package for Python on VantageCloud Lake
Introduction to Teradata Package for Python
Teradata Package for Python Product Overview
The teradataml Package
Key Feature Additions and Changes
Installing, Uninstalling, and Upgrading Teradata Package for Python
Installing Teradata Package for Python
Teradata Package for Python System Requirements
Installing Open Source Python on the Client
Installing Teradata Package for Python on a Client Through PyPI
Installing Teradata Package for Python on Windows
Installing Teradata Package for Python on macOS or Linux OS
Installing Teradata Package for Python from Teradata Downloads
Downloading Teradata Package for Python from Teradata Downloads
Installing Teradata Python Package on Windows from the Wheel File
Installing Teradata Python Package on macOS or Linux OS from the Wheel File
Testing Connection to Vantage
Uninstalling Teradata Package for Python
Upgrading Teradata Package for Python
teradataml Components
Helper Functions
load_example_data() Function
Garbage Collection in teradataml
Running SQL Queries using teradataml
DataFrames for Tables and Views
DataFrames from Teradata Vantage Data Sources
DataFrame Constructor
DataFrame.from_table() Function
DataFrame.from_query() Function
Access Tables in a Non-Default Database in Vantage
Input Classes for UAF Functions
TDSeries
TDAnalyticResult
TDMatrix
TDGenSeries
DataFrame Manipulation
select() Method
drop() Method
dropna() Method
assign() Method
Regular Aggregate Functions Supported by DataFrame
groupby() Method
Time Series Aggregates
Example Setup
groupby_time()
resample()
Time Series Aggregate Functions
concat() Method
describe() Method
Filtering Rows and Columns
filter() Method
item based Filtering
substring based Filtering
regex Filtering
index[] Operator
get() Method
get_values() Method
head and tail
head() Method
tail() Method
itertuples() Method
join() Method
iloc[] Operator
loc[] Operator
merge() Method
sample() Method
set_index() Method
show_query() Method
sort() Method
sort_index() Method
squeeze() Method
map_row() and map_partition() Methods
map_row() Method
map_partition() Method
apply Method
drop_duplicate() Function
cube() Function
rollup() Function
replace()
DataFrame Metadata
info() Method
keys() Method
DataFrame Properties
columns Property
dtypes Property
index Property
shape Property
size Property
tdtypes Property
Data Rotation
pivot()
unpivot()
Saving teradataml DataFrames to Vantage
to_sql() DataFrame Method
Exporting DataFrame to External Entities
to_pandas() Method
to_csv() Method
teradataml DataFrame Column
Access teradataml DataFrame Column
teradataml DataFrame Column Manipulation
isin()
NA Checking: isna()/notna() and isnull()/notnull() Methods
Type Casting: cast()
SQL Functions
to_numeric
case
desc
asc
distinct
String Manipulation
contains() Method
lower() Method
strip() Method
Regular Aggregate Functions Supported by DataFrame Column
Date Time Functions
String Functions
Regular Arithmetic Functions
Bit Byte Manipulation Functions
Regular Expression Functions
Comparison Functions
Trigonometric Functions
Hyperbolic Functions
teradataml Window Aggregates
Window on DataFrame
Window on DataFrame Column
Window Aggregate Functions
Context to Teradata Vantage
create_context
get_context
get_connection
set_context
remove_context
teradataml General Functions
Data Transfer Utility
Saving DataFrame to Vantage
copy_to_sql()
fastload()
fastexport()
Loading Data from CSV to Vantage
read_csv
Data Transfer between Vantage and Cloud Storage
Prerequisites
Create Authorization Object
Create Function Mapping
ReadNOS
WriteNOS
Database Utility
db_drop_table()
db_drop_view()
db_list_tables()
db_python_package_details()
display_analytic_functions()
list_td_reserved_keywords()
view_log()
File Management Functions
install_file()
remove_file()
Miscellaneous Functions
print_options()
show_versions()
execute_sql()
async_run_status()
Apply SET Operations on teradataml DataFrames
concat
td_except
td_intersect
td_minus
teradataml Options
Configuration Options
temp_table_database and temp_view_database
byom_install_location
val_install_location
database_version
read_nos_function_mapping
write_nos_function_mapping
certificate_file
indb_install_location
Display Options
byte_encoding
max_rows
precision
print_sqlmr_query
blob_length
suppress_vantage_runtime_warnings
geometry_column_length
set_config_params
Series
Series from teradataml DataFrame
Series Manipulation
head()
unique()
Series Metadata
name
BYOM
Supported External Model Types
PMMLPredict
H2OPredict
ONNXPredict
DataikuPredict
DataRobotPredict
save_byom()
list_byom()
retrieve_byom()
delete_byom()
set_byom_catalog()
set_license()
get_license()
BYOM Workflows
Working with Geospatial Data
teradataml Geometry Types
Point
LineString
Polygon
MultiPoint
MultiLineString
MultiPolygon
GeometryCollection
GeoSequence
teradataml GeoDataFrame
Access Geospatial Data on Vantage
GeoDataFrame Properties
GeoDataFrame Methods
teradataml GeoDataFrameColumn
Access Individual Geometry Columns
GeoDataFrameColumn Properties and Methods Specific to Geospatial Data
Use Case 1: Run a Single Geospatial Function
Use Case 2: Run Multiple Geospatial Functions
Use Case 3: Filtering using Geospatial Functions
GeoDataFrameColumn Properties
GeoDataFrameColumn Methods
Plotting in teradataml
Types of Plots
Bar Plot
Correlation Plot
Geometry Plot
Line Plot
Mesh Plot
Scatter Plot
Wiggle Plot
Combine Multiple Plots into a Single Plot
Composite Plot
Compositing Line Plot
Compositing Correlation Plot
Subplot
Subplotting with Every Individual Plot Occupies Same Area in Figure
Subplotting with Every Individual Plot Occupies Different Areas in Figure
Options for Plotting
Axis
Figure
Options Available for Plot Method
Hyperparameter Tuning in teradataml
GridSearch
Methods of GridSearch
_init_
fit
evaluate
predict
get_error_log
get_input_data
get_model
get_parameter_grid
is_running
set_model
Properties of GridSearch
best_data_id
best_model
best_model_id
best_params_
best_sampled_data_
best_score_
model_stats
models
Examples for GridSearch
Example 1: Using Hyperparameter Tuning for Model Trainer Function
Example 2: Input Data Hyper-parameterization for Model Trainer Function Tuning
Example 3: Hyperparameter Tuning Operations on Non-Model Trainer Function
Example 4: Parallelization in Hyperparameter Tuning for Model and Non-Model Trainer Functions
Example 5: Early Stopping Methods in Hyperparameter Tunning
Example 5 Setup
Example 5.1: Time Based Early Stopping for Model Trainer Function
Example 5.2: Time Based Early Stopping for Non-Model Trainer Function
Example 5.3: Metrics Based Early Stopping for Model Trainer Function
RandomSearch
Methods of RandomSearch
_init_
fit
evaluate
predict
get_error_log
get_input_data
get_model
get_parameter_grid
is_running
set_model
Properties of RandomSearch
best_data_id
best_model
best_model_id
best_params_
best_sampled_data_
best_score_
model_stats
models
Examples for RandomSearch
Example 1: Using Hyperparameter Tuning for Model Trainer Function
Example 2: Input Data Hyper-parameterization for Model Trainer Function Tuning
Example 3: Hyperparameter Tuning Operations on Non-Model Trainer Function
Example 4: Parallelization in Hyperparameter Tuning for Model and Non-Model Trainer Functions
Example 5: Early stopping methods in hyperparameter tunning
Example 5 Setup
Example 5.1: Time Based Early Stopping for Model Trainer Function
Example 5.2: Time Based Early Stopping for Non-Model Trainer Function
Example 5.3: Metrics Based Early Stopping for Model Trainer Function
AutoML in teradataml
Key Features of AutoML
Methods of AutoML
AutoML._init_
AutoRegressor._init_
AutoClassifier._init_
fit
leaderboard
leader
predict
generate_custom_config
Examples
Example 1: Run AutoML for Regression Problem with Early Stopping Timer and Metrics Threshold
Example 2: Run AutoRegressor for Regression Problem with Early Stopping Condition and Customization
Example 3: Run AutoClassifier for Classification Problem using Early Stopping Timer
Example 4: Run AutoML for Classification Problem using Early Stopping Timer and Customization
Example 5: Run AutoML for Multiclass Classification Problem using Early Stopping Timer
Example 6: Run AutoClassifier for Multiclass Classification Problem using Early Stopping Timer
Example 7: Run AutoML for Classification Problem Using Early Stopping Metrics and max_models
teradataml Open-Source Machine Learning Functions
Setup and Requirements
When Client is Connected to VantageCloud Enterprise
When Client is Connected to VantageCloud Lake
td_sklearn
Run scikit-learn Functions using Legacy Arguments
Run scikit-learn Functions using Teradata Introduced Arguments
Support for Distributed Modeling
Support for Classification and Regression Metrics
Support for Model Operations
Model Deployment
Model Loader
Example: Deploy and Load Distributed Model
Example: Deploy and Load Single Model
Example: Deploy and Load Model Trained outside Vantage
Limitations and Considerations
Working with Open Analytics
Prerequisite to Use Open Analytics Framework
APIs to Use with Open Analytics Framework
API to Set Authentication Token
set_auth_token
APIs to Manage User Environments
list_base_envs
create_env
list_user_envs
remove_env
remove_all_envs
APIs to Get Handler for Remote User Environment
get_env
APIs to Manage Files, Libraries, and Models inside a User Environment
files
install_file
remove_file
libs
install_lib
update_lib
uninstall_lib
models
install_model
uninstall_model
status
refresh
snapshot
teradataml Apply Class for APPLY Table Operator
Apply Function
Example 1: Working with Python Script
Example 2: Working with R Script
test_script
execute_script
set_data
deploy
Open Analytics Workflows
Using Teradata Vantage Analytic Functions with Teradata Package for Python
Usage Notes
Column Specification in Analytics Database Analytic Functions
load_example_data() Function
Use Cases
Text Analysis with teradataml Package
Using ClassificationEvaluator to Evaluate the Classification
Using GLM Model with teradataml Package
Using Decision Forest Model with teradataml Package
Clustering Using KMeans with teradataml Package
Churn Analysis Using Sessionize and NPath with Teradata Package for Python
Using DataFrame.map_partition() Function for GLM Model Fitting and Scoring Functions
Using PMMLPredict to Score using Externally Trained Models
Using H2OPredict to Score using Externally Trained Models
Using ONNXPredict to Score using Externally Trained Models
Using Open Analytics to Score using Externally Trained Models using Apply
Teradata Package for Python Function Reference on VantageCloud Lake
Teradata Package for Python Limitations
Open Analytics Login Issue with teradataml 17.20.00.05 and 17.20.00.06
DataFrame Creation on Primary Time Index Tables is Partially Supported
copy_to_sql and to_sql Functions Limitation
Multithreading and Concurrent Usage Limitations
print(dataframe.dtypes) Displays Column Types as String
Error Calling teradataml Analytic Functions
select() Method Requires Unique Column Names
Limited Missing Value Support
DataFrames Become Invalid When a Connection Context is Recreated
Error Using responses Argument in MLE Function NaïveBayesTextClassifierPredict
copy_to API When Loading Data into PTI Table
Teradata Package for Python Considerations
SQLAlchemy Compatibility Considerations
User Permissions in Vantage
Persistence of Tables Created by the teradataml Package in Vantage
Filtering with Boolean Column Requires a Comparison
String Comparisons may be Case Insensitive
Teradata Package for Python Issues with VIEW Creation
SQL versus teradataml Differences
Issue while Creating a teradataml DataFrame from a Table in Non-Default Database
Issue of not Having PERM SPACE to Create Temporary Tables
Issue while Accessing a View in other Schema
CREATE VIEW and SELECT WITH [non_default_database].[any_view] Issue Solution
Using teradataml with Native Object Store
Data in JSON or CSV Format
Example: Create teradataml DataFrame on NOS foreign table in JSON data format
Example: Create teradataml DataFrame on NOS foreign table in CSV data format
Accessing Columns and Path Variables using DataFrame.from_query()
Accessing Columns and Path Variables by Creating a View on Foreign Table
Accessing Columns and Path Variables by Creating a Table from Foreign Table
Data in Parquet Format
Accessing Foreign Table Created On Parquet Data
Accessing Path Variables using DataFrame.from_query()
Accessing Path Variables by Creating a View on Foreign Table in Vantage
Accessing Path Variables by Creating a Table from Foreign Table
teradataml Extension with SQLAlchemy
Accessing Vantage SQL Functions
Example: Accessing Vantage SQL Function with SQLAlchemy
Supported SQL Functions
Aggregate Functions
Arithmetic, Hyperbolic and Trigonometric Functions
Bit Byte Manipulation Functions
Built-In Functions
Hash Related Functions
Regular Expression Functions
String Functions
Window Aggregate Functions
Using SQLAlchemy Clause Element and Expression
Using Basic SQLAlchemy ClauseElement and Expression in DataFrame.assign()
Using Basic SQLAlchemy ClauseElement and Expression for Filtering
Data Type Mapping between Analytics Database, teradataml DataFrame dtypes and Python
Teradata pyspark2teradataml
Introduction to Teradata pyspark2teradataml
Key Feature Additions and Changes
Installing teradatamlspk Package
teradatamlspk Package System Requirements
Installing teradatamlspk on a Windows OS,macOS, Linux Client
PySpark to Vantage Migration
Step1: Run pyspark2teradataml with PySpark Script as Input
Step 2: Review the HTML Report
Example: Convert PySpark Script to teradatamlspk Script
Example Step 1: Convert PySpark Script to teradatamlspk Script
Example Step 2: Review the HTML Report and Modify the Script
Artifacts Used in PySpark to Vantage Example
Limitations and Considerations
Examples
Example: Create teradatamlspk DataFrame for Data in a Vantage Table or View
Examples: Partially Supported Functions
shiftright
shiftleft
contains
endswith
startswith
ilike
like
isNotNull
isNull
agg
crosstab
replace
join
crossjoin
orderBy and Sort
createTempView
createOrReplaceTempView
colRegex
unpivot
melt
pivot
fillna and na.fill
Read Parquet File
Read JSON File
Read CSV File
Write Parquet File
Write CSV File
Write saveAsTable
Write insertInto
MaxAbsScaler
OneHotEncoder
UnivariateFeatureSelector
VarianceThresholdSelector
Example: Use Pipeline Functionality
Use Pipeline in PySpark
Use Pipeline through teradataml Open-Source Machine Learning Functions
Example: Work with StandardScaler Function
Work with PySpark StandardScaler Function
Work with teradatamlspk StandardScaler Function
Bring Your Own Model
Vantage Analytics Library
In-DB Analytic Functions Explorer
Opening the In-DB Analytic Functions Explorer
Using the In-DB Analytic Functions Explorer
Using Build Query to Run an Analytic Query
Creating a View with the Query Results
Saving the Build Query Results: Permanent or Volatile Table
nPath Visualization
Creating New Connection
Accessing nPath User Interface
The nPath Function Cards
Generating a Query
nPath Event Table Structure
Analyzing the Tree Diagram
Analyzing the Sankey Chart
Database Unbounded Array Framework Time Series Functions
Unbounded Array Framework Specifications
Series Specifications
SERIES_SPEC Syntax
SERIES_SPEC Syntax Elements
SERIES_SPEC Examples
Matrix Specifications
MATRIX_SPEC Syntax
MATRIX_SPEC Syntax Elements
MATRIX_SPEC Examples
ART Specifications
ART_SPEC Syntax
ART_SPEC Syntax Elements
ART_SPEC Examples
Generated Series Specifications
GENSERIES_SPEC Syntax
GENSERIES_SPEC Syntax Elements
GENSERIES_SPEC Example
Database Unbounded Array Framework Time Series Function Categories
General Utility Functions
Data Preparation Functions
Anomaly Detection Functions
Diagnostic Statistical Test Functions
Digital Signal Processing Functions
Model Preparation and Parameter Estimation Functions
Series Forecasting Functions
Temporal and Spatial Functions
General Utility Functions
TD_CONVERTTABLEFORUAF
TD_CONVERTTABLEFORUAF Syntax
TD_CONVERTTABLEFORUAF Syntax Elements
TD_CONVERTTABLEFORUAF Input
TD_CONVERTTABLEFORUAF Output
TD_CONVERTTABLEFORUAF Examples
TD_COPYART
TD_COPYART Syntax
TD_COPYART Syntax Elements
TD_COPYART Input
TD_COPYART Output
TD_COPYART Examples
TD_EXTRACT_RESULTS
TD_EXTRACT_RESULTS Syntax
TD_EXTRACT_RESULTS Syntax Elements
TD_EXTRACT_RESULTS Input
TD_EXTRACT_RESULTS Output
TD_EXTRACT_RESULTS Examples
TD_FILTERFACTORY1D
TD_FILTERFACTORY1D Syntax
TD_FILTERFACTORY1D Syntax Elements
TD_FILTERFACTORY1D Input
TD_FILTERFACTORY1D Output
TD_FILTERFACTORY1D Examples
TD_IMAGE2MATRIX
TD_IMAGE2MATRIX Syntax
TD_IMAGE2MATRIX Syntax Elements
TD_IMAGE2MATRIX Input
TD_IMAGE2MATRIX Output
TD_IMAGE2MATRIX Examples
TD_INPUTVALIDATOR
TD_INPUTVALIDATOR Syntax
TD_INPUTVALIDATOR Syntax Elements
TD_INPUTVALIDATOR Input
TD_INPUTVALIDATOR Output
TD_INPUTVALIDATOR Example
TD_ISFINITE
TD_ISFINITE Syntax
TD_ISFINITE Input
TD_ISFINITE Output
TD_ISFINITE Examples
TD_ISINF
TD_ISINF Syntax
TD_ISINF Input
TD_ISINF Output
TD_ISINF Examples
TD_ISNAN
TD_ISNAN Syntax
TD_ISNAN Input
TD_ISNAN Output
TD_ISNAN Examples
TD_MATRIX2IMAGE
TD_MATRIX2IMAGE Syntax
TD_MATRIX2IMAGE Syntax Elements
TD_MATRIX2IMAGE Input
TD_MATRIX2IMAGE Output
TD_MATRIX2IMAGE Examples
TD_MINFO
TD_MINFO Syntax
TD_MINFO Syntax Elements
TD_MINFO Input
TD_MINFO Output
TD_MINFO Example
TD_PLOT
TD_PLOT Syntax
TD_PLOT Syntax Elements
TD_PLOT Input
TD_PLOT Output
TD_PLOT Examples
TD_SINFO
TD_SINFO Syntax
TD_SINFO Syntax Elements
TD_SINFO Input
TD_SINFO Output
TD_SINFO Example
TD_TRACKINGOP
TD_TRACKINGOP Syntax
TD_TRACKINGOP Syntax Elements
TD_TRACKINGOP Input
TD_TRACKINGOP Output
TD_TRACKINGOP Examples
Data Preparation Functions
TD_BINARYSERIESOP
TD_BINARYSERIESOP Syntax
TD_BINARYSERIESOP Syntax Elements
TD_BINARYSERIESOP Input
TD_BINARYSERIESOP Output
TD_BINARYSERIESOP Examples
TD_BINARYMATRIXOP
TD_BINARYMATRIXOP Syntax
TD_BINARYMATRIXOP Syntax Elements
TD_BINARYMATRIXOP Input
TD_BINARYMATRIXOP Output
TD_BINARYMATRIXOP Examples
TD_GENSERIES4FORMULA
TD_GENSERIES4FORMULA Syntax
TD_GENSERIES4FORMULA Syntax Elements
TD_GENSERIES4FORMULA Input
TD_GENSERIES4FORMULA Output
TD_GENSERIES4FORMULA Examples
TD_MATRIXMULTIPLY
TD_MATRIXMULTIPLY Syntax
TD_MATRIXMULTIPLY Syntax Elements
TD_MATRIXMULTIPLY Input
TD_MATRIXMULTIPLY Output
TD_MATRIXMULTIPLY Examples
TD_RESAMPLE
TD_RESAMPLE Syntax
TD_RESAMPLE Syntax Elements
TD_RESAMPLE Input
TD_RESAMPLE Output
TD_RESAMPLE Examples
Anomaly Detection Functions
TD_IQR
TD_IQR Syntax
TD_IQR Syntax Elements
TD_IQR Input
TD_IQR Output
TD_IQR Examples
Diagnostic Statistical Test Functions
TD_BREUSCH_GODFREY
TD_BREUSCH_GODFREY Syntax
TD_BREUSCH_GODFREY Syntax Elements
TD_BREUSCH_GODFREY Input
TD_BREUSCH_GODFREY Output
TD_BREUSCH_GODFREY Example
TD_BREUSCH_PAGAN_GODFREY
TD_BREUSCH_PAGAN_GODFREY Syntax
TD_BREUSCH_PAGAN_GODFREY Syntax Elements
TD_BREUSCH_PAGAN_GODFREY Input
TD_BREUSCH_PAGAN_GODFREY Output
TD_BREUSCH_PAGAN_GODFREY Example
TD_CUMUL_PERIODOGRAM
TD_CUMUL_PERIODOGRAM Syntax
TD_CUMUL_PERIODOGRAM Syntax Elements
TD_CUMUL_PERIODOGRAM Input
TD_CUMUL_PERIODOGRAM Output
TD_CUMUL_PERIODOGRAM Example
TD_DICKEY_FULLER
TD_DICKEY_FULLER Syntax
TD_DICKEY_FULLER Syntax Elements
TD_DICKEY_FULLER Input
TD_DICKEY_FULLER Output
TD_DICKEY_FULLER Example
TD_DURBIN_WATSON
TD_DURBIN_WATSON Syntax
TD_DURBIN_WATSON Syntax Elements
TD_DURBIN_WATSON Input
TD_DURBIN_WATSON Output
TD_DURBIN_WATSON Examples
TD_FITMETRICS
TD_FITMETRICS Syntax
TD_FITMETRICS Syntax Elements
TD_FITMETRICS Input
TD_FITMETRICS Output
TD_FITMETRICS Examples
TD_GOLDFELD_QUANDT
TD_GOLDFELD_QUANDT Syntax
TD_GOLDFELD_QUANDT Syntax Elements
TD_GOLDFELD_QUANDT Input
TD_GOLDFELD_QUANDT Output
TD_GOLDFELD_QUANDT Example
TD_PORTMAN
TD_PORTMAN Syntax
TD_PORTMAN Syntax Elements
TD_PORTMAN Input
TD_PORTMAN Output
TD_PORTMAN Examples
TD_SELECTION_CRITERIA
TD_SELECTION_CRITERIA Syntax
TD_SELECTION_CRITERIA Syntax Elements
TD_SELECTION_CRITERIA Input
TD_SELECTION_CRITERIA Output
TD_SELECTION_CRITERIA Examples
TD_SIGNIF_PERIODICITIES
TD_SIGNIF_PERIODICITIES Syntax
TD_SIGNIF_PERIODICITIES Syntax Elements
TD_SIGNIF_PERIODICITIES Input
TD_SIGNIF_PERIODICITIES Output
TD_SIGNIF_PERIODICITIES Example
TD_SIGNIF_RESIDMEAN
TD_SIGNIF_RESIDMEAN Syntax
TD_SIGNIF_RESIDMEAN Syntax Elements
TD_SIGNIF_RESIDMEAN Input
TD_SIGNIF_RESIDMEAN Output
TD_SIGNIF_RESIDMEAN Example
TD_WHITES_GENERAL
TD_WHITES_GENERAL Syntax
TD_WHITES_GENERAL Syntax Elements
TD_WHITES_GENERAL Input
TD_WHITES_GENERAL Output
TD_WHITES_GENERAL Example
Digital Signal Processing Functions
TD_DWT
TD_DWT Syntax
TD_DWT Syntax Elements
TD_DWT Input
TD_DWT Output
TD_DWT Examples
TD_DWT2D
TD_DWT2D Syntax
TD_DWT2D Syntax Elements
TD_DWT2D Input
TD_DWT2D Output
TD_DWT2D Examples
TD_IDWT
TD_IDWT Syntax
TD_IDWT Syntax Elements
TD_IDWT Input
TD_IDWT Output
TD_IDWT Examples
TD_IDWT2D
TD_IDWT2D Syntax
TD_IDWT2D Syntax Elements
TD_IDWT2D Input
TD_IDWT2D Output
TD_IDWT2D Examples
TD_SAX
TD_SAX Syntax
TD_SAX Syntax Elements
TD_SAX Input
TD_SAX Output
TD_SAX Examples
TD_WINDOWDFFT
TD_WINDOWDFFT Syntax
TD_WINDOWDFFT Syntax Elements
TD_WINDOWDFFT Input
TD_WINDOWDFFT Output
TD_WINDOWDFFT Examples
Model Preparation and Parameter Estimation Functions
Creating an ARIMA Model
TD_ACF
TD_ACF Syntax
TD_ACF Syntax Elements
TD_ACF Input
TD_ACF Output
TD_ACF Examples
TD_ARIMAESTIMATE
TD_ARIMAESTIMATE Syntax
TD_ARIMAESTIMATE Syntax Elements
TD_ARIMAESTIMATE Input
TD_ARIMAESTIMATE Output
TD_ARIMAESTIMATE Examples
TD_ARIMAVALIDATE
TD_ARIMAVALIDATE Syntax
TD_ARIMAVALIDATE Syntax Elements
TD_ARIMAVALIDATE Input
TD_ARIMAVALIDATE Output
TD_ARIMAVALIDATE Examples
TD_ARIMAXESTIMATE
TD_ARIMAXESTIMATE Syntax
TD_ARIMAXESTIMATE Syntax Elements
TD_ARIMAXFORECAST Input
TD_ARIMAXESTIMATE Output
TD_ARIMAXESTIMATE Examples
TD_AUTOARIMA
TD_AUTOARIMA Usage Notes
TD_AUTOARIMA Syntax
TD_AUTOARIMA Syntax Elements
TD_AUTOARIMA Input
TD_AUTOARIMA Output
TD_AUTOARIMA Examples
TD_DIFF
TD_DIFF Syntax
TD_DIFF Syntax Elements
TD_DIFF Input
TD_DIFF Output
TD_DIFF Examples
TD_LINEAR_REGR
TD_LINEAR_REGR Syntax
TD_LINEAR_REGR Syntax Elements
TD_LINEAR_REGR Input
TD_LINEAR_REGR Output
TD_LINEAR_REGR Examples
TD_MULTIVAR_REGR
TD_MULTIVAR_REGR Syntax
TD_MULTIVAR_REGR Syntax Elements
TD_MULTIVAR_REGR Input
TD_MULTIVAR_REGR Output
TD_MULTIVAR_REGR Examples
TD_PACF
TC_PACF Syntax
TC_PACF Syntax Elements
TD_PACF Input
TD_PACF Output
TD_PACF Example
TD_POWERTRANSFORM
TD_POWERTRANSFORM Syntax
TD_POWERTRANSFORM Syntax Elements
How BACK_TRANSFORM, P, B, and LAMBDA Determine Transform Equation
TD_POWERTRANSFORM Input
TD_POWERTRANSFORM Output
TD_POWERTRANSFORM Example
TD_SEASONALNORMALIZE
TD_SEASONALNORMALIZE Syntax
TD_SEASONALNORMALIZE Syntax Elements
TD_SEASONALNORMALIZE Input
TD_SEASONALNORMALIZE Output
TD_SEASONALNORMALIZE Examples
TD_SMOOTHMA
TD_SMOOTHMA Syntax
TD_SMOOTHMA Syntax Elements
TD_SMOOTHMA Input
TD_SMOOTHMA Output
TD_SMOOTHMA Examples
TD_UNDIFF
TD_UNDIFF Syntax
TD_UNDIFF Syntax Elements
TD_UNDIFF Input
TD_UNDIFF Output
TD_UNDIFF Example
TD_UNNORMALIZE
TD_UNNORMALIZE Syntax
TD_UNNORMALIZE Syntax Elements
TD_UNNORMALIZE Input
TD_UNNORMALIZE Output
TD_UNNORMALIZE Example
Series Forecasting Functions
TD_ARIMAFORECAST
TD_ARIMAFORECAST Syntax
TD_ARIMAFORECAST Syntax Elements
TD_ARIMAFORECAST Input
TD_ARIMAFORECAST Output
TD_ARIMAFORECAST Examples
TD_ARIMAXFORECAST
TD_ARIMAXFORECAST Syntax
TD_ARIMAXFORECAST Syntax Elements
TD_ARIMAXFORECAST Input
TD_ARIMAXFORECAST Output
TD_ARIMAXFORECAST Examples
TD_DTW
TD_DTW Syntax
TD_DTW Syntax Elements
TD_DTW Input
TD_DTW Output
TD_DTW Examples
TD_HOLT_WINTERS_FORECASTER
TD_HOLT_WINTERS_FORECASTER Syntax
TD_HOLT_WINTERS_FORECASTER Syntax Elements
TD_HOLT_WINTERS_FORECASTER Input
TD_HOLT_WINTERS_FORECASTER Output
TD_HOLT_WINTERS_FORECASTER Examples
TD_KALMAN_FORECASTER
TD_KALMAN_FORECASTER Syntax
TD_KALMAN_FORECASTER Required Syntax Elements
TD_KALMAN_FORECASTER Optional Syntax Elements
TD_KALMAN_FORECASTER Input
TD_KALMAN_FORECASTER Output
TD_KALMAN_FORECASTER Examples
TD_MAMEAN
TD_MAMEAN Syntax
TD_MAMEAN Syntax Elements
TD_MAMEAN Input
TD_MAMEAN Output
TD_MAMEAN Examples
TD_SIMPLEEXP
TD_SIMPLEEXP Syntax
TD_SIMPLEEXP Syntax Elements
TD_SIMPLEEXP Input
TD_SIMPLEEXP Output
TD_SIMPLEEXP Examples
TD_SMOOTHMA_FORECASTER
TD_SMOOTHMA_FORECASTER Syntax
TD_SMOOTHMA_FORECASTER Required Syntax Elements
TD_SMOOTHMA_FORECASTER Optional Syntax Elements
TD_SMOOTHMA_FORECASTER Input
TD_SMOOTHMA_FORECASTER Output
TD_SMOOTHMA_FORECASTER Examples
Temporal and Spatial Functions
TD_CONVOLVE
TD_CONVOLVE Syntax
TD_CONVOLVE Syntax Elements
TD_CONVOLVE Input
TD_CONVOLVE Output
TD_CONVOLVE Example
TD_CONVOLVE2
TD_CONVOLVE2 Syntax
TD_CONVOVLE2 Syntax Elements
TD_CONVOLVE2 Input
TD_CONVOLVE2 Output
TD_CONVOLVE2 Examples
TD_DFFT
TD_DFFT Syntax
TD_DFFT Syntax Elements
TD_DFFT Input
TD_DFFT Output
TD_DFFT Example
TD_DFFT2
TD_DFFT2 Syntax
TD_DFFT2 Syntax Elements
TD_DFFT2 Input
TD_DFFT2 Output
TD_DFFT2 Example
TD_DFFTCONV
TD_DFFTCONV Syntax
TD_DFFTCONV Syntax Elements
TD_DFFTCONV Input
TD_DFFTCONV Output
TD_DFFTCONV Example
TD_DFFT2CONV
TD_DFFT2CONV Syntax
TD_DFFT2CONV Syntax Elements
TD_DFFT2CONV Input
TD_DFFT2CONV Output
TD_DFFT2CONV Example
TD_GENSERIES4SINUSOIDS
TD_GENSERIES4SINUSOIDS Syntax
TD_GENSERIES4SINUSOIDS Syntax Elements
TD_GENSERIES4SINUSOIDS Input
TD_GENSERIES4SINUSOIDS Output
TD_GENSERIES4SINUSOIDS Example
TD_IDFFT
TD_IDFFT Syntax
TD_IDFFT Syntax Elements
TD_IDFFT Input
TD_IDFFT Output
TD_IDFFT Examples
TD_IDFFT2
TD_IDFFT2 Syntax
TD_IDFFT2 Syntax Elements
TD_IDFFT2 Input
TD_IDFFT2 Output
TD_IDFFT2 Example
TD_LINESPEC
TD_LINESPEC Syntax
TD_LINESPEC Syntax Elements
TD_LINESPEC Input
TD_LINESPEC Output
TD_LINESPEC Examples
TD_POWERSPEC
TD_POWERSPEC Syntax
TD_POWERSPEC Syntax Elements
TD_POWERSPEC Input
TD_POWERSPEC Output
TD_POWERSPEC Examples
Mathematic Operators and Functions
Mathematic Operators
Mathematic Functions
Formula Rules
UAF Analytic Functions Examples
Analytics Database Analytic Functions
Analytics Database Analytic Function Categories
Data Cleaning Functions
Data Exploration Functions
Feature Engineering Transform Functions
Feature Engineering Utility Functions
Model Training Functions
Model Scoring Functions
Model Evaluation Functions
Text Analytic Functions
Hypothesis Testing Functions
Path and Pattern Analysis Functions
Usage Notes
How to Read Syntax
Input Table Rows Redistribution
Function Syntax Descriptions
Size of the Query
AMP Configuration Impact on Function Execution
Limitations When Using PARTITION BY
Functions Ignore Disallowed Syntax Elements
Input Table Schemas
Function Names with and without TD Prefix
Accumulated Columns Impact on Function Performance
Datatype Change in Accumulated Columns
Displaying Online Help for Analytics Database Analytic Functions
BC/BCE Timestamps
Workload Management Configuration for Analytics Database Analytic Functions
Avoid Deadlocks Using Volatile Tables
Non-Deterministic Behavior
Maximum Number of Columns in a Database Table
Spool Space Exhaustion for Large Partitions at High Concurrency
Recommendations for Using Analytic Functions
Data Cleaning Functions
Pack
Pack Syntax
Required Syntax Elements for Pack
Optional Syntax Elements for Pack
Pack Input
Pack Output
Examples: How to Use Pack
Pack Examples Input
Example: Default Options
Example: Nondefault Options
StringSimilarity
StringSimilarity Syntax
StringSimilarity Syntax Elements
StringSimilarity Input
StringSimilarity Output
Examples: How to Use StringSimilarity
StringSimilarity with Specified Column Names
StringSimilarity with Specified Column Ranges
TD_ConvertTo
TD_ConvertTo Syntax
Required Syntax Elements for TD_ConvertTo
Optional Syntax Elements for TD_ConvertTo
TD_ConvertTo Input
TD_ConvertTo Output
TD_ConvertTo Usage Notes
Example: How to Use TD_ConvertTo
TD_GetFutileColumns
TD_GetFutileColumns Syntax
Required Syntax Elements for TD_GetFutileColumns
Optional Syntax Elements for TD_GetFutileColumns
TD_GetFutileColumns Input
TD_GetFutileColumns Output
Example: How to Use TD_GetFutileColumns
TD_GetRowsWithoutMissingValues
TD_GetRowsWithoutMissingValues Syntax
TD_GetRowsWithoutMissingValues Syntax Elements
TD_GetRowsWithoutMissingValues Input
TD_GetRowsWithoutMissingValues Output
Example: How to Use TD_GetRowsWithoutMissingValues
TD_OutlierFilterFit
TD_OutlierFilterFit Syntax
TD_OutlierFilterFit Syntax Elements
TD_OutlierFilterFit Input
TD_OutlierFilterFit Output
Example: Using TD_OutlierFilterFit with Percentile Method
TD_OutlierFilterTransform
TD_OutlierFilterTransform Syntax
Required Syntax Elements for TD_OutlierFilterTransform
Optional Syntax Elements for TD_OutlierFilterTransform
TD_OutlierFilterTransform Input
TD_OutlierFilterTransform Output
Example: How to Use TD_OutlierFilterTransform
TD_SimpleImputeFit
TD_SimpleImputeFit Syntax
Required Syntax Elements for TD_SimpleImputeFit
Optional Syntax Elements for TD_SimpleImputeFit
TD_SimpleImputeFit Input
TD_SimpleImputeFit Output
Example: How to Use TD_SimpleImputeFit
TD_SimpleImputeTransform
TD_SimpleImputeTransform Syntax
Required Syntax Elements for TD_SimpleImputeTransform
Optional Syntax Elements for TD_SimpleImputeTransform
TD_SimpleImputeTransform Input
TD_SimpleImputeTransform Output
Example: How to Use TD_SimpleImputeTransform
Unpack
Unpack Syntax
Unpack Syntax Elements
Unpack Input
Unpack Output
Examples: How to Use Unpack
Example: Delimiter Separates Virtual Columns
Example: No Delimiter Separates Virtual Columns
Example: More Input Columns than Output Columns
Example: Input Columns with Trailing Special Characters
Data Exploration Functions
MovingAverage
Simple Moving Average
Weighted Moving Average
Exponential Moving Average
Modified Moving Average
Cumulative Moving Average
Triangular Moving Average
MovingAverage Syntax
Required Syntax Elements for MovingAverage
Optional Syntax Elements for MovingAverage
MovingAverage Input
MovingAverage Output
Examples: How to Use MovingAverage
MovingAverage Examples Input
Example: Simple Moving Average
Example: Weighted Moving Average
Example: Exponential Moving Average
Example: Modified Moving Average
Example: Cumulative Moving Average
Example: Triangular Moving Average
TD_CategoricalSummary
TD_CategoricalSummary Syntax
Required Syntax Elements for TD_CategoricalSummary
Optional Syntax Elements for TD_CategoricalSummary
TD_CategoricalSummary Input
TD_CategoricalSummary Output
Example: How to Use TD_CategoricalSummary
TD_ColumnSummary
TD_ColumnSummary Syntax
Required Syntax Elements for TD_ColumnSummary
Optional Syntax Elements for TD_ColumnSummary
TD_ColumnSummary Input
TD_ColumnSummary Output
Example: How to Use TD_ColumnSummary
TD_GetRowsWithMissingValues
TD_GetRowsWithMissingValues Syntax
Required Syntax Elements for TD_GetRowsWithMissingValues
Optional Syntax Elements for TD_GetRowsWithMissingValues
TD_GetRowsWithMissingValues Input
TD_GetRowsWithMissingValues Output
Example: Using TD_GetRowsWithMissingValues to Find NULL Values
TD_Histogram
TD_Histogram Syntax
Required Syntax Elements for TD_Histogram
Optional Syntax Elements for TD_Histogram
TD_Histogram Input
TD_Histogram Output
Examples: How to Use TD_Histogram
TD_QQNorm
TD_QQNorm Syntax
Required Syntax Elements for TD_QQNorm
Optional Syntax Elements for TD_QQNorm
TD_QQNorm Input
TD_QQNorm Output
Example: How to Use TD_QQNorm
TD_UnivariateStatistics
TD_UnivariateStatistics Syntax
TD_UnivariateStatistics Syntax Elements
TD_UnivariateStatistics Input
TD_UnivariateStatistics Output
Example: Using TD_UnivariateStatistics to Determine Mean, Median, and Mode
TD_WhichMax
TD_WhichMax Syntax
Required Syntax Elements for TD_WhichMax
Optional Syntax Elements for TD_WhichMax
TD_WhichMax Input
TD_WhichMax Output
TD_WhichMax Example
TD_WhichMin
TD_WhichMin Syntax
Required Syntax Elements for TD_WhichMin
Optional Syntax Elements for TD_WhichMin
TD_WhichMin Input
TD_WhichMin Output
TD_WhichMin Example
Feature Engineering Transform Functions
Antiselect
Antiselect Syntax
Antiselect Syntax Elements
Antiselect Input
Antiselect Output
Antiselect Examples
Antiselect Example: No Column Ranges
Antiselect Example: Column Range
TD_BinCodeFit
TD_BinCodeFit Syntax
Required Syntax Elements for TD_BinCodeFit
Optional Syntax Elements for TD_BinCodeFit
TD_BinCodeFit Input
TD_BinCodeFit Output
Example: How To Use TD_BinCodeFit
TD_BinCodeTransform
TD_BinCodeTransform Syntax
Required Syntax Elements for TD_BinCodeTransform
Optional Syntax Elements for TD_BinCodeTransform
TD_BinCodeTransform Input
TD_BinCodeTransform Output
TD_BinCodeTransform Usage Notes
Example: How to Use TD_BinCodeTransform
TD_ColumnTransformer
TD_ColumnTransformer Syntax
TD_ColumnTransformer Syntax Elements
TD_ColumnTransformer Input
TD_ColumnTransformer Output
TD_ColumnTransformer Example
TD_FunctionFit
TD_FunctionFit Syntax
TD_FunctionFit Input
TD_FunctionFit Output
TD_FunctionFit Example
TD_FunctionTransform
TD_FunctionTransform Syntax
TD_FunctionTransform Syntax Elements
TD_FunctionTransform Input
TD_FunctionTransform Output
TD_FunctionTransform Example
TD_NonLinearCombineFit
TD_NonLinearCombineFit Syntax
Required Syntax Elements for TD_NonLinearCombineFit
Optional Syntax Elements for TD_NonLinearCombineFit
TD_NonLinearCombineFit Input
TD_NonLinearCombineFit Output
Example: How to Use TD_NonLinearCombineFit
TD_NonLinearCombineTransform
TD_NonLinearCombineTransform Syntax
Required Syntax Elements for TD_NonLinearCombineTransform
Optional Syntax Elements for TD_NonLinearCombineTransform
TD_NonLinearCombineTransform Input
TD_NonLinearCombineTransform Output
Example: How to Use TD_NonLinearCombineTransform
TD_OneHotEncodingFit
TD_OneHotEncodingFit Syntax
Required Syntax Elements for TD_OneHotEncodingFit
Optional Syntax Elements for TD_OneHotEncodingFit
TD_OneHotEncodingFit Input
TD_OneHotEncodingFit Output
TD_OneHotEncodingFit Usage Notes
Example: How to Use TD_OneHotEncodingFit
TD_OneHotEncodingTransform
TD_OneHotEncodingTransform Syntax
Required Syntax Elements for TD_OneHotEncodingTransform
Optional Syntax Elements for TD_OneHotEncodingTransform
TD_OneHotEncodingTransform Input
TD_OneHotEncodingTransform Output
Example: How to Use TD_OneHotEncodingTransform
TD_OrdinalEncodingFit
TD_OrdinalEncodingFit Syntax
TD_OrdinalEncodingFit Syntax Elements
TD_OrdinalEncodingFit Input
TD_OrdinalEncodingFit Output
Example: How to Use TD_OrdinalEncodingFit
TD_OrdinalEncodingTransform
TD_OrdinalEncodingTransform Syntax
TD_OrdinalEncodingTransform Syntax Elements
TD_OrdinalEncodingTransform Input
TD_OrdinalEncodingTransform Output
Example: How to Use TD_OrdinalEncodingTransform
TD_Pivoting
TD_Pivoting Syntax
Required Syntax Elements for TD_Pivoting
Optional Syntax Elements for TD_Pivoting
TD_Pivoting Input
TD_Pivoting Output
Example: How to Use TD_Pivoting
RowsPerPartition
PivotColumn
Aggregation with PivotColumn
Aggregation Only
TD_PolynomialFeaturesFit
TD_PolynomialFeaturesFit Syntax
TD_PolynomialFeaturesFit Syntax Elements
TD_PolynomialFeaturesFit Input
TD_PolynomialFeaturesFit Output
Example: How to Use TD_PolynomialFeaturesFit
TD_PolynomialFeaturesTransform
TD_PolynomialFeaturesTransform Syntax
TD_PolynomialFeaturesTransform Syntax Elements
TD_PolynomialFeaturesTransform Input
TD_PolynomialFeaturesTransform Output
Example: How to Use TD_PolynomialFeaturesTransform
TD_RandomProjectionFit
TD_RandomProjectionFit Syntax
TD_RandomProjectionFit Syntax Elements
TD_RandomProjectionFit Input
TD_RandomProjectionFit Output
TD_RandomProjectionFit Example
TD_RandomProjectionMinComponents
TD_RandomProjectionMinComponents Syntax
TD_RandomProjectionMinComponents Syntax Elements
TD_RandomProjectionMinComponents Input
TD_RandomProjectionMinComponents Output
TD_RandomProjectionMinComponents Example
TD_RandomProjectionTransform
TD_RandomProjectionTransform Syntax
TD_RandomProjectionTransform Syntax Elements
TD_RandomProjectionTransform Input
TD_RandomProjectionTransform Output
TD_RandomProjectionTransform Example
TD_RowNormalizeFit
TD_RowNormalizeFit Syntax
Required Syntax Elements for TD_RowNormalizeFit
Optional Syntax Elements for TD_RowNormalizeFit
TD_RowNormalizeFit Input
TD_RowNormalizeFit Output
Example: How to Use TD_RowNormalizeFit
TD_RowNormalizeTransform
TD_RowNormalizeTransform Syntax
Required Syntax Elements for TD_RowNormalizeTransform
Optional Syntax Elements for TD_RowNormalizeTransform
TD_RowNormalizeTransform Input
TD_RowNormalizeTransform Output
Example: How to Use TD_RowNormalizeTransform
TD_ScaleFit
TD_ScaleFit Syntax
Required Syntax Elements for TD_ScaleFit
Optional Syntax Elements for TD_ScaleFit
TD_ScaleFit Input
TD_ScaleFit Output
Examples: How to Use TD_ScaleFit
Dense Input
Sparse Input without Partition
Sparse Input with Partition
TD_ScaleTransform
TD_ScaleTransform Syntax
Required Syntax Elements for TD_ScaleTransform
Optional Syntax Elements for TD_ScaleTransform
TD_ScaleTransform Input
TD_ScaleTransform Output
Examples: How to Use TD_ScaleTransform
Dense Input
Sparse Input without Partition
Sparse Input with Partition
TD_SMOTE
TD_SMOTE Syntax
Required Syntax Elements for TD_SMOTE
Optional Syntax Elements for TD_SMOTE
TD_SMOTE Input
TD_SMOTE Output
Examples: How to Use TD_SMOTE
Using SamplingStrategy with smote, adasyn or borderline Values
Using SamplingStrategy with smotenc Values
TD_TargetEncodingFit
TD_TargetEncodingFit Syntax
TD_TargetEncodingFit Syntax Elements
TD_TargetEncodingFit Input
TD_TargetEncodingFit Output
TD_TargetEncodingFit Usage Notes
TD_TargetEncodingFit Examples
TD_TargetEncodingTransform
TD_TargetEncodingTransform Syntax
TD_TargetEncodingTransform Syntax Elements
TD_TargetEncodingTransform Input
TD_TargetEncodingTransform Output
TD_TargetEncodingTransform Usage Notes
TD_TargetEncodingTransform Examples
TD_Unpivoting
TD_Unpivoting Syntax
Required Syntax Elements for TD_Unpivoting
Optional Syntax Elements for TD_Unpivoting
TD_Unpivoting Input
TD_Unpivoting Output
TD_Unpivoting Usage Notes
Example: How to Use TD_Unpivoting
Feature Engineering Utility Functions
TD_FillRowID
TD_FillRowID Syntax
Required Syntax Elements for TD_FillRowID
Optional Syntax Elements for TD_FillRowID
TD_FillRowID Input
TD_FillRowID Output
Example: Using TD_FillRowID to Generate Row Identifiers
TD_NumApply
TD_NumApply Syntax
TD_NumApply Syntax Elements
TD_NumApply Input
TD_NumApply Output
Example: How to Use TD_NumApply
TD_RoundColumns
TD_RoundColumns Syntax
Required Syntax Elements for TD_RoundColumns
Optional Syntax Elements for TD_RoundColumns
TD_RoundColumns Input
TD_RoundColumns Output
Example: How to Use TD_RoundColumns
TD_RoundColumns Column Examples
TD_StrApply
TD_StrApply Syntax
TD_StrApply Syntax Elements
TD_StrApply Input
TD_StrApply Output
Example: How to Use TD_StrApply
Model Training Functions
TD_DecisionForest
TD_DecisionForest Syntax
Required Syntax Elements for TD_DecisionForest
Optional Syntax Elements for TD_DecisionForest
TD_DecisionForest Input
TD_DecisionForest Output
TD_DecisionForest Examples
TD_GLM
TD_GLM Syntax
Required Syntax Elements for TD_GLM
Optional TD_GLM Syntax Elements
TD_GLM Input
TD_GLM Output
Examples: How to Use TD_GLM
TD_KMeans
TD_KMeans Syntax
Required Syntax Elements for TD_KMeans
Optional Syntax Elements for TD_KMeans
TD_KMeans Input
TD_KMeans Output
TD_KMeans Usage Notes
Example: How to Use TD_KMeans
TD_KNN
TD_KNN Syntax
TD_KNN Syntax Elements
TD_KNN Input
TD_KNN Output
Examples: How to Use TD_KNN
Example: Using TD_KNN To Predict Weight Based on Height and Age
Example: Using TD_KNN with Classification
Example: Using TD_KNN with Neighbors
TD_NaiveBayes
TD_NaiveBayes Syntax
Required Syntax Elements for TD_NaiveBayes
Optional Syntax Elements for TD_NaiveBayes
TD_NaiveBayes Input
TD_NaiveBayes Output
Example: How to Use TD_NaiveBayes
TD_OneClassSVM
TD_OneClassSVM Syntax
Required Syntax Elements for TD_OneClassSVM
Optional Syntax Elements for TD_OneClassSVM
TD_OneClassSVM Input
TD_OneClassSVM Output
TD_OneClassSVM Usage Notes
Example: How to Use TD_OneClassSVM
TD_SVM
TD_SVM Syntax
Required Syntax Elements for TD_SVM
Optional Syntax Elements for TD_SVM
TD_SVM Input
TD_SVM Output
Examples: How to Use TD_SVM
TD_VectorDistance
TD_VectorDistance Syntax
TD_VectorDistance Syntax Elements
TD_VectorDistance Input
TD_VectorDistance Output
Example: TD_VectorDistance Using Euclidean, Manhattan, and Cosine
TD_XGBoost
TD_XGBoost Syntax
Required Syntax Elements for TD_XGBoost
Optional Syntax Elements for TD_XGBoost
TD_XGBoost Input
TD_XGBoost Output
Examples: How to Use TD_XGBoost
TD_XGBoost for Classification
TD_XGBoost for Regression
TD_XGBoost for JSON Tree Model String
Model Scoring Functions
TD_DecisionForestPredict
TD_DecisionForestPredict Syntax
Required Syntax Elements for TD_DecisionForestPredict
Optional Syntax Elements for TD_DecisionForestPredict
TD_DecisionForestPredict Input
TD_DecisionForestPredict Output
Example: How to Use TD_DecisionForestPredict
TD_GLMPredict
TD_GLMPredict Syntax
TD_GLMPredict Syntax Elements
TD_GLMPredict Input
TD_GLMPredict Output
Examples: How to Use TD_GLMPredict
TD_KMeansPredict
TD_KMeansPredict Syntax
Required Syntax Elements for TD_KMeansPredict
TD_KMeansPredict Input
TD_KMeansPredict Output
Example: How to Use the k-means Algorithm
Examples: How to Use TD_KMeansPredict
TD_NaiveBayesPredict
TD_NaiveBayesPredict Syntax
Required Syntax Elements for TD_NaiveBayesPredict
Optional Syntax Elements for TD_NaiveBayesPredict
TD_NaiveBayesPredict Input
TD_NaiveBayesPredict Output
Example: How to Use TD_NaiveBayesPredict
TD_OneClassSVMPredict
TD_OneClassSVMPredict Syntax
Required Syntax Elements for TD_OneClassSVMPredict
Optional Syntax Elements for TD_OneClassSVMPredict
TD_OneClassSVMPredict Input
TD_OneClassSVMPredict Output
Example: How to Use TD_OneClassSVMPredict
TD_SVMPredict
TD_SVMPredict Syntax
Required Syntax Elements for TD_SVMPredict
Optional Syntax Elements for TD_SVMPredict
TD_SVMPredict Input
TD_SVMPredict Output
TD_SVMPredict Usage Notes
Examples: How to Use TD_SVMPredict
TD_XGBoostPredict
TD_XGBoostPredict Syntax
Required Syntax Elements for TD_XGBoostPredict
Optional Syntax Elements for TD_XGBoostPredict
TD_XGBoostPredict Input
TD_XGBoostPredict Output
Examples: How to Use TD_XGBoostPredict
XGBoostPredict for Classification
XGBoostPredict for Regression
Model Evaluation Functions
TD_SHAP
TD_SHAP Syntax
Required Syntax Elements for TD_SHAP
Optional Syntax Elements for TD_SHAP
TD_SHAP Input
TD_SHAP Output
Example: How to Use TD_SHAP
Regression Model Using TrainingFunction with TD_GLM
Classification Model Using TrainingFunction with TD_XGBoost
TD_Silhouette
TD_Silhouette Syntax
Required Syntax Elements for TD_Silhouette
Optional Syntax Elements for TD_Silhouette
TD_Silhouette Input
TD_Silhouette Output
Example: How to Use TD_Silhouette
TD_ClassificationEvaluator
TD_ClassificationEvaluator Syntax
Required Syntax Elements for TD_ClassificationEvaluator
Optional Syntax Elements for TD_ClassificationEvaluator
TD_ClassificationEvaluator Input
TD_ClassificationEvaluator Output
TD_ClassificationEvaluator Usage Notes
Example: How to Use TD_ClassificationEvaluator
TD_RegressionEvaluator
TD_RegressionEvaluator Syntax
TD_RegressionEvaluator Syntax Elements
TD_RegressionEvaluator Input
TD_RegressionEvaluator Output
Example: How to Use TD_RegressionEvaluator
TD_ROC
TD_ROC Syntax
Required Syntax Elements for TD_ROC
Optional Syntax Elements for TD_ROC
TD_ROC Input
TD_ROC Output
Example: How to Use TD_ROC
TD_TrainTestSplit
TD_TrainTestSplit Syntax
Required Syntax Elements for TD_TrainTestSplit
Optional Syntax Elements for TD_TrainTestSplit
TD_TrainTestSplit Input
TD_TrainTestSplit Output
TD_TrainTestSplit Examples
Text Analytic Functions
TD_Ngramsplitter
TD_Ngramsplitter Syntax
Required Syntax Elements for TD_Ngramsplitter
Optional Syntax Elements for TD_Ngramsplitter
TD_Ngramsplitter Input
TD_Ngramsplitter Output
TD_Ngramsplitter Usage Notes
Examples: How to Use TD_Ngramsplitter
TD_Ngramsplitter Examples Input
Example: Omit Accumulate
Example: Specify Accumulate
TD_NaiveBayesTextClassifierPredict
TD_NaiveBayesTextClassifierPredict Syntax
TD_NaiveBayesTextClassifierPredict Syntax Elements
TD_NaiveBayesTextClassifierPredict Input
TD_NaiveBayesTextClassifierPredict Output
TD_NaiveBayesTextClassifierPredict Examples
TD_NaiveBayesTextClassifierPredict Example: TopK Specified
TD_NaiveBayesTextClassifierPredict Example: Responses Specified
TD_NaiveBayesTextClassifierTrainer
TD_NaiveBayesTextClassifierTrainer Syntax
TD_NaiveBayesTextClassifierTrainer Syntax Elements
TD_NaiveBayesTextClassifierTrainer Input
TD_NaiveBayesTextClassifierTrainer Output
Example: Using TD_NaiveBayesTextClassifierTrainer with Multinomial Model Type
TD_SentimentExtractor
TD_SentimentExtractor Syntax
TD_SentimentExtractor Syntax ElementsRequired Syntax Elements for TD_SentimentExtractor
TD_SentimentExtractor Input
TD_SentimentExtractor Output
TD_SentimentExtractor Examples
TD_TextParser
TD_TextParser Syntax
Required Syntax Elements for TD_TextParser
Optional Syntax Elements for TD_TextParser
TD_TextParser Input
TD_TextParser Output
TD_TextParser Example
TD_TFIDF
TD_TFIDF Syntax
Required Syntax Elements for TD_TFIDF
Optional Syntax Elements for TD_TFIDF
TD_TFIDF Input
TD_TFIDF Output
Example: How to Use TD_TFIDF
TD_WordEmbeddings
TD_WordEmbeddings Syntax
Required Syntax Elements for TD_WordEmbeddings
Optional Syntax Elements for TD_WordEmbeddings
TD_WordEmbeddings Input
TD_WordEmbeddings Output
Example: How to Use TD_WordEmbeddings
Hypothesis Testing Functions
Hypothesis Test Components
Hypothesis Test Types
TD_ANOVA
TD_ANOVA Syntax
Required Syntax Elements for TD_ANOVA
Optional Syntax Elements for TD_ANOVA
TD_ANOVA Input
TD_ANOVA Output
Examples: How to Use TD_ANOVA
Using TD_ANOVA to Determine Difference of Insect Sprays
Using GroupNames Argument
Using NumGroups Argument
TD_ChiSq
TD_ChiSq Syntax
Required Syntax Elements for TD_ChiSq
Optional Syntax Elements for TD_ChiSq
TD_ChiSq Input
TD_ChiSq Output
TD_ChiSq Usage Notes
TD_FTest
TD_FTest Syntax
Required Syntax Elements for TD_FTest
Optional Syntax Elements for TD_FTest
TD_FTest Input
TD_FTest Output
TD_FTest Usage Notes
Examples: How to Use TD_FTest
Using FirstSampleVariance and SecondSampleVariance Arguments
Using FirstSampleName and SecondSampleName Arguments
Using FirstSampleName and SecondSampleVariance Arguments
Using SecondSampleName and FirstSampleVariance Arguments
TD_ZTest
TD_ZTest Syntax
Required Syntax Elements for TD_ZTest
Optional Syntax Elements for TD_ZTest
TD_ZTest Input
TD_ZTest Output
TD_ZTest Usage Notes
Examples: How to Use TD_ZTest
Using Two-tailed Test
Using Two Samples
Using One Sample
Path and Pattern Analysis Functions
Terminology
Attribution
Attribution Syntax
Attribution Syntax Elements
Attribution Input
Model Specification
Attribution Output
Example: Model Assigns Attribution Weights to Events and Channels
nPath
nPath Syntax
nPath Syntax Elements
nPath Input
nPath Output
nPath Symbols
LAG and LEAD Expressions in Symbol Predicates
LAG Expression Syntax
LAG and LEAD Expression Rules
LAG and LEAD Expressions Example: Alias for Input Query
LAG and LEAD Expressions Example: No Alias for Input Query
nPath Patterns
nPath Greedy Pattern Matching
nPath Filters
nPath Filters Example
nPath Results
nPath Results Examples
nPath Results Example: FIRST, LAST_NOTNULL, MAX_CHOOSE, and MIN_CHOOSE
nPath Results Example: FIRST and Three Forms of ACCUMULATE
nPath Results Example: FIRST, Three Forms of ACCUMULATE, COUNT, and NTH
nPath Results Example: Combine Values from One Row with Values from the Next Row
nPath Results Example: ACCUMULATE String over 64000 Characters
nPath Results Example: ACCUMULATE String over 64000 Characters, DISTINCT
nPath Results Example: ACCUMULATE String over 64000 Characters, CDISTINCT
nPath Results Example: Hindi Input, ACCUMULATE FIRST_NOTNULL
nPath Results Example: Hindi Input, ACCUMULATE DISTINCT and CDISTINCT
nPath Examples
Symbols and Symbol Predicates That Examples Use
nPath ClickStream Data Examples
nPath Range-Matching Examples
nPath Range-Matching Example: Accumulate Pages Visited in Each Session
nPath Range-Matching Example: Find Sessions That Start at Home Page and Visit Page1
nPath Range-Matching Example: Find Paths to Checkout Page for Purchases Over $200
nPath Range-Matching Example: Use OVERLAPPING Mode
nPath Range-Matching Example: Find First Product with Multiple Referrers in Any Session
nPath Range-Matching Example: Find Data for Sessions That Checked Out 3-6 Products
nPath Range-Matching Example: Find Data for Sessions That Checked Out at Least 3 Products
nPath Range-Matching Example: Multiple Partitioned Input Tables and Dimension Input Table
Sessionize
Sessionize Syntax
Required Syntax Elements for Sessionize
Optional Syntax Elements for Sessionize
Sessionize Input
Sessionize Output
Example: How to Use Sessionize
UDFs and External Stored Procedures in VantageCloud Lake
External Routine Migration Tool
Installing the External Routine Migration Tool
Specifying XRMigrationTool Options
XRMigrationTool Syntax
Migration Tool Config File
PAT Support in XRMigrationTool
Migrating Existing SQL Scripts to VantageCloud Lake
Running the External Routine Migration Tool
Running Migrated Scripts
Example: Migrating Existing UDF SQL Scripts to VantageCloud Lake
External Routine Installation Tool
Installing the External Routine Installation Tool
Specifying tdextroutine Options and Environment Variables
tdextroutine UDF Subcommands and Options
tdextroutine External Stored Procedure Subcommands and Options
UDF Manifest File
Example: UDF Manifest File
External Stored Procedure Manifest File
Creating UDFs
Creating a C, C++, or Java UDF
Example: Creating a C UDF
Using UDFs
Call a UDF
List C/C++ or Java UDFs
Get Details about a C/C++ or Java UDF
Replace a C/C++ or Java UDF
Redistribute a Java UDF JAR File
Delete a Java UDF JAR File
Drop a C/C++ or Java UDF
Creating and Using External Stored Procedures
Using Data Protection to Backup and Restore Data
Backup and Restore with Data Protection
Creating a Backup Plan
Immutability of Backups (AWS)
Editing a Backup Plan
Viewing History of a Backup Plan
Restoring Data from a Restore Point
Protecting a Restore Point
Stopping a Running Backup Plan
Disaster Recovery with Cross Site Recovery of Backups
Creating a Disaster Recovery Plan
Editing a Disaster Recovery Plan
Testing the Disaster Recovery Events
Recovering Data from Unplanned DR Events
How Backup and Restore Works in VantageCloud Lake
Monitoring Performance and Resource Usage
Monitor Primary and Compute Cluster APIs
Monitor Resource Usage
resusagesawtV
resusagescpuV
resusageshstV
resusagesldvV
resusagespdskV
resusagespmaV
resusagespsV
resusagesvdskV
resusagesvprV
Monitor Compute Cluster Events
ComputeProfileHistoryV[X]
ComputeProfileHistoryEventsV[X]
Monitor Queries
dbqlexplainV
dbqlobjV
dbqlogV
dbqlsqlV
dbqlstepV
dbqlsummaryV
dbqlutilityV
Query Monitoring Examples
Example: dbqlogV - Tracking Data Volume for Specific Load Jobs
Example: dbqlogV - See the Number of Rows Inserted, Updated, or Deleted for DML Statements
Example: dbqlstepV - Detect the Longest Running Query in a Time Frame
Example: dbqlutilityV - Retrieve Start Time, End Time, and Row Counts
Troubleshooting: Query Logging Views for Teradata Employees
Bring Your Own Viewpoint
Multi-System Viewpoint Support for the BYOVP Model
Multi-System Viewpoint Availability by Deployment Option
Considerations in Using Viewpoint
Data Collector Support for BYOVP
Database Reference
Analytics Database International Character Set Support
Managing International Language Support
Implementation Overview
Character Set Categories
System Processing of Character Data
System Default Character Support
Default Client Character Set Support
US-ASCII Character Set
US-ASCII
Differences between TD-ASCII and US-ASCII
US-ASCII Repertoire Comparison
Usage Notes
Use Cases for US-ASCII
Example: US-ASCII Attempted Import of a French String Literal
Example: US-ASCII Attempted Usage of a French Object Name
Standard Language Support Mode
Object Names
Object Naming Controls
Rules for Object Naming
UNICODE Characters Allowed in Object Names
Display of Incompatible Object Names and Literals
Client Character Set Options
Teradata Support for Common Client Character Sets
Client Character Set Support
Client Character Set Compatibility with Server Character Sets
Client Character Set Compatibility by Client Type
EBCDIC Client Character Set Support
ASCII Client Character Set Support
UTF8 Client Character Set Support
UTF16 Client Character Set Support
Endianness
Error Messages
Using Standard Teradata Client Character Sets
System Determination of Client Character Set
Assigning the Default Client Character Set during Client Setup
Assigning the Default Client Character Set by HostId
DBC.HostsInfoV View
Finding the LogicalHostId
Assigning the Default Client Character Set for a Session
Server Character Sets
Character Data Storage
Working with Server Character Set Defaults
Default Server Character Set Options
Specifying the Default Server Character Set
LATIN Server Character Set
Client Character Sets Supported with LATIN
Differences between ASCII and Teradata LATIN
Detecting ASCII and Teradata LATIN Differences
Using LATIN Characters above ASCII X'7F'
Supported Characters
UNICODE Server Character Set
Sharing UNICODE Data among Heterogeneous Clients
Supported UNICODE Client Character Sets
UNICODE Server Character Set Definition
Areas of Unicode
KANJISJIS Server Character Set
Sharing KANJISJIS Data among Heterogeneous Clients
Supported KANJISJIS Client Character Sets
KANJISJIS Character Set Limitations
GRAPHIC Server Character Set
Collation Sequences
Standard Collation Sequences
Collation Sequence Ordering
ASCII and EBCDIC Collations
CHARSET_COLL Collation
JIS_COLL Collation
MULTINATIONAL Collation
Available Collation Sequences
Multilevel Collation
MULTINATIONAL Collation Rules
Example: Teradata Standard Multinational Collation Equivalence Class
Equivalence Classes and Ordering in Class
Making MULTINATIONAL the Default Collation Sequence
MULTINATIONAL Collation Related Information
Character Conversion
External Character Conversion
Application Model with Single Form of Use
Example: UTF8 Form-of-Use
Example: Data Returned in ASCII
Working with Export Widths
Interpreting the Export Width Rule Set for EXPECTED
Viewing the Current Export Widths for a Session
Exception Handling
Illegal Form-of-Use
E2I Conversion Exceptions
I2E Conversion Exceptions
Error Characters
Truncation Exceptions
Truncation Exceptions and Fixed Length Columns
Truncation Exceptions When Converting Fixed Length Columns
Truncation of a Pass Through Character (PTC)
Other Truncation Exceptions
Truncation and Transaction Mode
Truncation Exceptions in ANSI Mode
Truncation Exceptions in Teradata Mode
Truncation Examples
UNICODE PASS THROUGH
Pass-Through Characters
Enabling and Disabling UNICODE PASS THROUGH
UNICODE PASS THROUGH Functionality
Importing Unicode Characters in a Pass Through Session
Exporting from a UNICODE Server Character Set
Ill-formed Code Unit Sequences
UNICODE PASS THROUGH Usage Notes
UPT Restrictions
Character Shorthand Notation
Japanese Encodings and Mapping Standards
JIS X 0201
JIS X 0208
Shift-JIS (DOS Kanji) Encoding
Shift-JIS (DOS Kanji) Usage Notes
Shift-JIS Encoding
Selected Characters for Shift-JIS Kanji
Shift-JIS Encoding for Kanji
Shift-JIS Encoding: Detailed View
Shift-JIS (DOS Kanji) Related Information
ASCII Mappings
Client ASCII to Server LATIN
Client ASCII to Server Unicode
EBCDIC Mappings
Client EBCDIC to Server LATIN
Client EBCDIC to Server Unicode
Mappings for String Functions
Pad Character Translation
Space Folding
Non-GRAPHIC Characters
UNICODE Halfwidth to Fullwidth
UNICODE Fullwidth to Halfwidth
UNICODE to LATIN
LATIN Uppercase to Lowercase
Multibyte KANJISJIS Lowercase to Uppercase
Single-Byte KANJISJIS Lowercase to Uppercase
UNICODE Lowercase to Uppercase
UNICODE Uppercase to Lowercase
KanjiShiftJIS Mappings
KANJISJIS to KANJISJIS Single-Byte
UNICODE to KanjiShiftJIS Single-Byte
Character Set Files
Downloading Character Set Files as Zip File
Data Dictionary
Downloading Teradata Studio or Teradata Studio Express
What the Data Dictionary Stores
Data Dictionary Views
Unicode Views
Compatibility Views
X Views
Non-X Views
Other Views
Access to Data Dictionary Views
Default PUBLIC Privileges for Views
Views for Which PUBLIC Privileges Are not Granted by Default
Compatibility View Privileges
Trusted Sessions Support in X Views
Querying Data Dictionary Views
How to See All Columns of a View
Querying X and Non-X Views
Using HELP and COMMENT
Tracking Resource Usage
AllSpace and TableSize Views
AMPUsage View
Example: Using DiskspaceV
Compiling AMPUsage Statistics
Tracking User Activity
Tracking Logon Rules
Tracking Privileges
Accessing PM/API-Related Data in the Data Dictionary
Example: Using SessionInfoV to Determine Who Is Using the Monitor
Example: Using AllRightsV to Determine User Access Rights
Example: Using LogOnOffV to Determine Which Users Were Forced Off the System
Using System Views
System Calendar View
Sys_Calendar.CALENDAR_TD1310
To Revert the View to the Current Version
Privilege
Example: Using Sys_Calendar.Calendar
SQLJ System Views
JAR_JAR_USAGE View
Example: Using SQLJ.Jar_Jar_Usage
JARS View
Example: Finding JAR Objects Accessible to a USER from SQLJ.Jars
ROUTINE_JAR_USAGE View
Example: Determining Users JAR Objects Using SQLJ.Routine_JAR_Usage
User Installed Files View
Using Unicode Views to Update Object Names
Teradata QueryGrid
TDMaps
Views Reference
Data Dictionary View Categories
TDMaps Views
AccessLogV
Usage Notes
Example: Using AccessLogV
AccLogRulesV
Usage Notes
Example: Using AccLogRulesV
AccountInfoV[X]
Usage Notes
Example: Using AccountInfoV
Related Topics
ActionHistoryV[X]
Usage Notes
ActionsV[X]
Usage Notes
Example: Updating ActionsTbl Row
All_RI_ChildrenV[X]
Usage Notes
All_RI_ParentsV[X]
Usage Notes
AllGlobalSpaceV[X]
Usage Notes
AllRightsV[X]
Usage Notes
Example: Using AllRightsV
AllRoleRightsV
Usage Notes
Example: Using AllRoleRightsV
AllSpaceV[X]
Usage Notes
Example: Using AllSpaceV
AllTempTablesV[X]
Example: Using AllTempTablesVX
AMPUsageV[X]
Usage Notes
Example: Using AMPUsageV
Related Topics
ArchiveLoggingObjsV[X]
Example: Using ArchiveLoggingObjsV
AssociationV[X]
Usage Notes
Example: Using AssociationV
Related Topics
AuthorizationsV[X]
Usage Notes
Example: Using AuthorizationsV
BusinessCalendar
Usage Notes
Examples: Queries of Calendar Data
Related Topics
BusinessCalendarExceptions
Usage Notes
BusinessCalendarPatterns
Usage Notes
CDSTableSizeV
CharSetsV
Usage Notes
Example: Using CharSetsV
CharTranslationsV
Usage Notes
Example: Using CharTranslationsV
ChildrenV[X]
Usage Notes
Example: Using ChildrenV
CloudGrantsV[X]
ComputeGroupStatusV[X]
ComputeGroupsV[X]
ComputeMapsV
ComputeProfilesV[X]
ComputeStatusV[X]
CollationsV
Usage Notes
Example: Using CollationsV
Related Topics
ColumnStatsV
Usage Notes
To Get Information Not Contained in This View
Example: Using ColumnStatsV
Related Topics
ColumnsV[X]
Usage Notes
Example: Using ColumnsV
Example: Select the CommentString Column from ColumnsV
Related Topics
ColumnUseCountV[X]
Usage Notes
Example: Using ColumnUseCountV
ConnectRulesV
Example: Select the CONNECT THROUGH Privileges for All Proxy Users from ConnectRulesV
Example: Select the CONNECT THROUGH Privileges for a Proxy User from ConnectRulesV
ConstraintFunctionsV
ConstraintValuesV
CostProfiles_v
Usage Notes
CostProfileTypes_v
Usage Notes
CostProfileValues_v
Usage Notes
Database_Default_JournalsV[X]
Usage Notes
Example: Using Database_Default_JournalsV
Databases2V[X]
Usage Notes
DatabasesV[X]
Usage Notes
Example: Using DatabasesV
DatabaseUseCountV[X]
Usage Notes
Example: Using DatabaseUseCountV
DatasetSchemaDependenciesV
Usage Notes
DatasetSchemaInfoV
Usage Notes
DBCInfoV
Example: Using DBCInfoV
DBQLRulesV
Usage Notes
Example: Using DBQLRulesV
DeleteAccessLogV
Usage Notes
Example: Using DeleteAccessLogV
DeleteOldInDoubtV
Usage Notes
Example: Using DeleteOldInDoubtV
DeleteUseCountV[X]
Usage Notes
Example: Using DeleteUseCountV
DiskGlobalSpaceErrorV
Usage Notes
DiskSpaceErrorV
Usage Notes
Related Topics
DiskSpaceV[X]
Usage Notes
Examples: Using DiskSpaceV
ErrorTblsV[X]
Usage Notes
Example: Using ErrorTblsV
Events_ConfigurationV[X]
Usage Notes
Example: Using Events_ConfigurationV
Events_MediaV[X]
Usage Notes
Example: Using Events_MediaV
EventsV[X]
Usage Notes
Example: Using EventsV
ExclusionListsV[X]
Usage Notes
ExportWidthV
How to Interpret ExportWidthRuleSet Column Values
Related Topics
ExpStatsV
Usage Notes
To Get Information Not Contained in This View
Example: Using ExpStatsV
Related Topics
ExternalSPsV[X]
Usage Notes
Example: Using ExternalSPsV
ForeignTablesInfoV[X]
ForeignTablesV[X]
FunctionAliasInfoV[X]
Usage Notes
FunctionAliasV[X]
FunctionsV[X]
Usage Notes
Example: Using FunctionsV
GlobalDBSpaceV[X]
Usage Notes
Example Requests for Space Information
HostsInfoV
Usage Notes
Example: Using HostsInfoV
IndexConstraintsV[X]
Usage Notes
Example: Select a List of Tables and Join Indexes with Partitioning from IndexConstraints
Example: Select a List of Tables and Join Indexes with Single-level Partitioning from IndexConstraints
IndexStatsV[X]
Usage Notes
To Get Information Not Contained in This View
Example: Using IndexStatsV
Related Topics
IndexUseCountV[X]
Usage Notes
Example: Using IndexUseCountV
IndicesV[X]
Usage Notes
Example: Using Indices
InDoubtLogV
Usage Notes
InsertUseCountV[X]
Usage Notes
Example: Using InsertUseCountV
JoinIndicesV
Usage Notes
Example: Create Join Index
Example: Using JoinIndicesV
JournalsV[X]
Example: Using JournalsV
LogOnOffV[X]
Usage Notes
Example: Using LogOnOffV
Related Topics
LogonRulesV
Usage Notes
MapGrantsV[X]
Usage Notes
MapListsV[X]
Usage Notes
MapsV[X]
Usage Notes
MultiColumnStatsV
Usage Notes
To Get Information Not Contained in This View
Example: Using MultiColumnStatsV
Related Topics
MultiExpStatsV
Usage Notes
To Get Information Not Contained in This View
Example: Using MultiExpStatsV
Related Topics
MultiVersionInfoTblV[X]
OFSTablesV[X]
ObjectsInSparseMapsV
Usage Notes
ObjectListsV[X]
Usage Notes
ObjectUseCountV[X]
Usage Notes
Example: Using ObjectUseCountV
PartitioningConstraintsV[X]
Usage Notes
Examples
Related Topics
PeriodsV[X]
Usage Notes
Example: Using PeriodsVX
ProfileAsgdSecConstraintsV[X]
Usage Notes
ProfileInfoV[X]
Usage Notes
Example: Using ProfileInfoV
QryLockLogXMLV
Usage Notes
Example: Using QryLockLogXMLV
Related Topics
QryLogAmpDataV
Example: Using QryLogAmpDataV
QryLogClientAttrV
Usage Notes
Examples: Using QryLogClientAttrV
QryLogEventHisV
Usage Notes
Example: Using DBC.QryLogEventHisV
Example: Selecting All Columns from QryLogEventHisV
Example: Using QryLogEventHisV to Show Flex Throttle Events
QryLogEventsV
Usage Notes
Example: Using QryLogEventsV
Example: Using QryLogEventsV to Query Flex Throttle Columns
QryLogExceptionsV
Usage Notes
Example: Using QryLogExceptionsV
QryLogExplainDocV
Usage Notes
Example: Using QryLogExplainDocV
Improving Explain Text Readability
QryLogExplainV
Usage Notes
Example: Using QryLogExplainV
QryLogExtAmpDataV
Example: Using QryLogExtAmpDataV
QryLogExtAmpDataV1V
Example: Using QryLogExtAmpDataV1V
QryLogExtAmpDataV2V
Example: Using QryLogExtAmpDataV2V
QryLogExtAmpDataV3V
Example: Using QryLogExtAmpDataV3V
QryLogExtAmpDataV4V
Example: Using QryLogExtAmpDataV4V
QryLogExtAmpDataV5V
Example: Using QryLogExtAmpDataV5V
QryLogExtAmpDataV6V
Example: Using QryLogExtAmpDataV6V
QryLogExtAmpDataV7V
Example: Using QryLogExtAmpDataV7V
QryLogExtPeDataV
Example: Using QryLogExtPeDataV
QryLogExtPeDataV1V
Example: Using QryLogExtPeDataV1V
QryLogExtPeDataV2V
Example: Using QryLogExtPeDataV2V
QryLogExtPeDataV3V
Example: Using QryLogExtPeDataV3V
QryLogExtPeDataV4V
Example: Using QryLogExtPeDataV4V
QryLogExtPeDataV5V
Example: Using QryLogExtPeDataV5V
QryLogExtPeDataV6V
Example: Using QryLogExtPeDataV6V
QryLogExtPeDataV7V
Example: Using QryLogExtPeDataV7V
QryLogFeatureListV
Usage Notes
Examples: Using QryLogFeatureListV
QRYLOGFEATUREUSECOUNTV
Usage Notes
QryLogFeatureUseJSON
Usage Notes
Example: Using QryLogFeatureUseJSON
QryLogObjectsV
Usage Notes
Example: Using QryLogObjectsV
QryLogParamJSON
Usage Notes
Example: Select JSON Data from QryLogParamJSON
Example: Select PARAMINFO from QryLogParamJSON
Example: Extract JSON Name/Value Pairs from the JSON Document
Example: Extract Specific JSON Values from the JSON Document
QryLogParamV
Usage Notes
Example: Using QryLogParamV
QryLogSQLDocV
Usage Notes
Example: Using QryLogSQLDocV
Improving SQL Text Readability
QryLogSQLV
Usage Notes
Example: Using QryLogSQL
QryLogStepsV
Usage Notes
Step Descriptions
Example: Using QryLogStepsV
Example: Using QryLogStepsV with ServerByteCount
QryLogSummaryV
Usage Notes
Rows Generated by the THRESHOLD Option
Rows Generated by the SUMMARY Option
Example: Using QryLogSummaryV
QryLogTdwmSumV
Usage Notes
Example: Select from DBC.QryLogTDWMSum
QryLogTDWMV
Usage Notes
Example: Select from QryLogTDWMV
QryLogUtilityV
Usage Notes
Example: Using QryLogUtilityV
QryLogV
Usage Notes
Example: Select a Specific QueryID from QryLogV
Example: Track Data Volume for Specific Load Jobs from QryLogV
Example: Using StmtDMLRowCount
QRYLogXMLDocV
Usage Notes
Example: Export XML Documents from QryLogXMLDocV
Example: Verifying XMLTextDoc is a Valid XML Document
Example: Serialize XMLTextDoc Document into a String
Improving XML Text Readability
Related Topics
QryLogXMLV
Usage Notes
Examples Using QryLogXMLV
Related Topics
RCC_ConfigurationV[X]
Example: Using RCC_ConfigurationV
RCC_MediaV[X]
Example: Using RCC_MediaV
ReconfigDeleteOrderV
Usage Notes
ReconfigInfoV
Usage Notes
ReconfigRedistOrderV
Usage Notes
ReconfigTableStatsV
Usage Notes
RepCaptureRulesV
Example: Using RepCaptureRulesV
RepTablesV[X]
ResolvedDTSV[X]
Usage Notes
Example: Using ResolvedDTSV
RestrictedWordsV
RI_Child_TablesV[X]
Usage Notes
RI_Distinct_ChildrenV[X]
Usage Notes
RI_Distinct_ParentsV[X]
Usage Notes
RI_Parent_TablesV[X]
Usage Notes
RoleInfoV[X]
Example: Using RoleInfoV
RoleMembersV[X]
Usage Notes
Example: Using RoleMembersV
SecConstraintsV[X]
Usage Notes
SecurityDefaultsV
Related Topics
SecurityLogV[X]
Usage Notes
ServerInfoV[X]
Usage Notes
ServerV[X]
Usage Notes
SessionInfoV[X]
Usage Notes
Example: Using SessionInfoV
Related Topics
SettingsV
Usage Notes
SHOWCOLCHECKSV[X]
Usage Notes
SHOWTBLCHECKSV[X]
Usage Notes
Software_Event_LogV
Usage Notes
Example: Using Software_Event_LogV
SparseMapAmpsV
Usage Notes
StatsV
Usage Notes
To Get Information Not Contained in This View
Example: Using StatsV
Related Topics
StatUseCountV[X]
Example: Using StatUseCountV[X]
StorageGrantsV[X]
StorageNVPInfoV[X]
StorageV[X]
Table_LevelConstraintsV[X]
Usage Notes
Tables2V[X]
Usage Notes
Tables3V[X]
Usage Notes
TableSizeV[X]
Usage Notes
Examples: Using TableSizeV
TableStatsV
Usage Notes
To Get Information Not Contained in This View
Example: Using TableStatsV
Related Topics
TablesV[X]
Usage Notes
Example: Using TablesV
Related Topics
TableTextV[X]
Usage Notes
Example: Using TableTextV
TableToSparseMapSizingV[X]
Usage Notes
TblSrvInfoV[X]
Usage Notes
TblSrvV[X]
Usage Notes
TempTableStatsV
Usage Notes
Related Topics
TriggersV[X]
Usage Notes
Example: Using TriggersV
Related Topics
UpdateUseCountV[X]
Usage Notes
Example: Using UpdateUseCountV
User_Default_JournalsV[X]
Example: Using User_Default_JournalsVX
UserGrantedRightsV
Usage Notes
Example: Using UserGrantedRightsV
UserRightsV
Usage Notes
Example: Using UserRightsV
UserRoleRightsV
Usage Notes
Example: Using UserRoleRightsV
UsersV
Usage Notes
Example: Using UsersV
Related Topics
UsrAsgdSecConstraintsV[X]
Usage Notes
ZoneGuestsV[X]
Usage Notes
ZonesV[X]
Usage Notes
Data Dictionary Tables
Downloading Teradata Studio or Teradata Studio Express
How Tables Are Created
Accessing Tables
Nonhashed Tables
DBCExtension Tables
Updating Tables
Character Data
Maintaining System Logs
Data Dictionary Logs that Require Manual Purging
Manually Deleting Old Log Data
View Column Values
AccessRight Column
ConstraintType Column
ExceptionValue Column
JournalFlag Column
NoSQLDataAccess Column
ProcessOffline Column
RoutineKind Column
StatsSource Column
TableKind Column
TimeDimension Column
VTCheckType Column
LogonSource Column Fields and Examples
Mainframe-Attached Systems Using the CLIv2 API
Workstation-Attached Systems Using CLIv2 API
Example: An Archive Job
Example: A BTEQ Job
JDBC Driver API
Example: LogonSource
ODBC Driver API
Example: Teradata ODBC Driver
.NET Data Provider for Teradata API
Example: .NET Data Provider for Teradata API
PDE Internal Session
Example: PDE Internal Session
Data Types for Unicode Views
Database Objects
Database Administration
Setting Up Your Administrative Environment: All DBAs
Logging in to the Operating System
User DBC
Setting Up the Database Administrator User
Creating the Database Administrator Profile
Creating the Database Administrator User
Granting Database Privileges to User DBADMIN
Setting Up the Compute Cluster Administrative Users
Creating Compute Cluster Administrative Users
Granting CREATE COMPUTE GROUP Privileges to the Compute Cluster Administrator
Granting CREATE COMPUTE PROFILE Privileges to the Vantage Cloud Administrator Profile
Granting Compute Cluster Privileges to Roles
Granting Users Access to Compute Clusters
Setting Up Compute Cluster Administrative Users - SQL Examples
Creating a Spool Reserve Database
Guidelines for Reserving Minimum Spool Space
Working with Compute Resources: Compute DBAs
SUSPEND COMPUTE and RESUME COMPUTE
SUSPEND COMPUTE
SUSPEND COMPUTE Syntax
SUSPEND COMPUTE Syntax Elements
SUSPEND COMPUTE Syntax Rules
SUSPEND COMPUTE Usage
SUSPEND COMPUTE Examples
RESUME COMPUTE
RESUME COMPUTE Syntax
RESUME COMPUTE Syntax Elements
RESUME COMPUTE Syntax Rules
RESUME COMPUTE Usage
RESUME COMPUTE Examples
Databases and Users in Teradata: All DBAs
Databases and Users
Space Used by Databases and Users
Creating or Owning Objects in the Hierarchy
Creating a Database or User
The System Users
System User DBC
System User SYSTEMFE
System User SYSADMIN
Other System Databases and Users
As-A-Service System Users
Recommended Hierarchy
Vantage Storage Overview
Object Storage Space Management
CREATE TABLE STORAGE Option
Setting DEFAULT STORAGE for Users and Databases
Working with Databases: All DBAs
Database Creation
Best Practices for Database Creation
Creating the Tables Database
Creating the Views Database
Working with Table Access Privileges for Views
Dropping a Database or User
Transferring Ownership with GIVE
Working with Tables and Views: Application DBAs
Choosing a Primary Index
Guidelines for Choosing Primary Index Columns
Unique and Nonunique Primary Indexes
Row Partitioning
No Primary Index (NoPI) Tables
Relationship of Primary Indexes, Primary Keys, and Foreign Keys
Creating Tables
Converting Existing Database Tables to Vantage Tables
Considerations for Defining Tables
Creating Tables in Teradata
Copying a Table
Copying Statistics from a Base to a Target Table
Dropping a Table
Recreating a Table
Using INSERT ... SELECT to Populate New Table
Specifying Fallback Tables
Working with Views
Creating Views Procedure
Example: Creating a View to Limit User Access
Example: Creating a View to Generate a Report
Working with Views Related Information
Getting View Column Information
Using BTEQ Scripts to Create Database Objects
Working with Stored Procedures and User-defined Functions: Application DBAs
Creating Stored Procedures
Example 1: Compiling and Running a Stored Procedure with a Cursor
Example 2: Creating a Stored Procedure to Update Accrued Interest
Creating User-Defined Functions
Example: Creating a User-Defined Function to Verify a Date
Working with Users, Roles, and Profiles: Operational DBAs
Overview of Establishing Users
Types of Users
Assessing Database User Needs
Best Practices for Creating Users
Creating User Accounts
Determining Account for User Session
Creating User Profiles
Use of Profiles
Precedence of Values for Profile Parameters
Creating Profiles
Dropping Profiles
Working with Database Users
Creating Database Users
Creating Temporary Passwords for First Login
Using Roles to Manage User Privileges
User Types and Minimum Required Privileges
Types of Privileges
Limitations on Using Roles
Create User Roles
When to Grant Privileges to a Role
Granting Privileges to a Role
Granting User Membership in a Role
Dropping a Role
Defining the Default Role for a User
Assigning the Default Role
Dropping the Default Role
Granting Privileges Directly to Users
Granting Privileges to Users Prerequisites
Example: Granting Privileges on Sys_Calendar to All Users
Granting Privileges to a User
Automatic Privileges for Creators
Automatic Privileges for Created Users and Databases
Granting Privileges to Users Related Information
Setting Up Compute Cluster Roles, Compute Profiles, and Compute Groups and Allowing Users Access
Compute Maps
CREATE COMPUTE GROUP: SQL
Creating Compute Profiles
Creating Compute Cluster Roles
Granting Users Access to Compute Groups
Loading and Exporting Data: Application DBAs
Teradata Parallel Transporter
Basic Teradata Query for Loading Tables
Differences between BTEQ and Teradata PT
Updating Tables
Loading Data into Analytics Database
Restarts and Aborts on BTEQ Jobs with Identity Column
FastLoad Utility
FastExport Utility
MultiLoad Utility
Maximum Number of Concurrent FastLoad, MultiLoad, and FastExport Jobs
Utility Management
Teradata Parallel Data Pump
Loading Geospatial Data
Loading Unicode Data with UNICODE PASS THROUGH
BTEQ, Teradata Parallel Transporter, and JDBC Examples
Teradata Studio Example
Usage Notes
Interpreting LOAD Utility Status
Choosing the Best Utility for Your Purpose
Definitions
Guidelines for Inserting Rows
Guidelines for Deleting Rows
Guidelines for Other Batch Operations
Utility Job Performance Analysis and Capacity Planning
Example: Investigating Why a Job Ran Slower Today
Example: Performance Anomaly Detection
Example: Capacity Planning
Working with Sessions and Accounts: Operational DBAs
Session Modes and Transaction Processing
Transaction Processing in ANSI Session Mode
Transaction Processing in Teradata Session Mode
Setting the Session Mode
Checking for Logged On Sessions
Getting Session Information
Troubleshooting Problems with Sessions
Working with Accounts
Purpose of System Accounting
Creating Accounts
Migrating Accounts from VantageCloud Enterprise or VantageCore
Working with System Accounting Views
DBC.AccountInfoV
DBC.AMPUsage View
Account String Variable
ASE Substitution Variables
Restrictions and Usage Rules
Using ASE with Client Utilities
Managing Space: Operational DBAs
Types of Space
Global Space Accounting
Example: Create a User with a Skew Limit
Considerations for Global Space Accounting
Interaction between Skew Factor and a Profile
Interaction between the Skew Factor and Soft Limits
Fixing Issues with Space Accounting
FixAllocatedSpace
FixAllocatedSpace Syntax
FixAllocatedSpace Usage Notes
FixAllocatedSpace Example
FixCurrentSpace
FixCurrentSpace Syntax
FixCurrentSpace Usage Notes
FixCurrentSpace Example
Identifying Space Issues by Querying System Views
Querying the DiskSpaceV View to Find System Space Issues
Querying the TableSizeV View
Use of the AllSpaceV View
Example Requests for Space Information
Transferring Ownership and Permanent Space
Transferring Permanent Space
Increasing the Spool Space Limit for a User
Finding and Fixing Skewed Tables by Querying the TableSizeV View
Example: Finding Skewed Tables by Querying the TableSizeV View
Defining Temporary Space Limits
Protecting Transactions by Reserving Cylinders for Perm Space
Example: Creating a Macro for Space Usage Reporting
Other Ways to View Space Usage
Managing Data Blocks
Managing Cylinders
Giving One User to Another
Maintaining the Database: Operational DBAs
Database Maintenance Tasks
Managing Accumulated Log Data
Database Logs
Method for Maintaining Database Logs
Telemetry Reporting Service
Deleting Old Log Data Manually from System Tables
Maintaining Data Dictionary Tables
Clearing the System Logs
Clearing Values Manually in the DBC.Acctg Table
Archiving and Resetting Accumulators and Peak Values
Collecting Statistics on Data Dictionary Tables
Data Dictionary Tables that Require Maintenance
Housekeeping on an Ad Hoc Basis
Updating Software (Applying Proper Patches)
Archiving, Restoring, and Recovering Data: Operational DBAs
Archive/Restore Utility Support
Managing Queries: Operational DBAs
Redrive Protection for Queries
Recommendations for Common Query Problems
Finding and Fixing Skewed Tables
Finding and Resolving Lock Contentions
Lock Levels
Improving Query Performance Using COLLECT STATISTICS: Application DBAs
Statistics Collection
When to Collect Statistics
Collecting Statistics
Stale Statistics
SUMMARY Statistics
Skipping Unneeded Statistics Recollection with the THRESHOLD Option
Sampling Statistics with the USING SAMPLE Option
Example: User-Specified Sample Percentage
Example: System-Determined Sample Statistics
Working with Special Cases
Collecting Statistics on Tables Protected with Row-Level Security
Collecting Statistics on Null
Tracking Query Behavior with Database Query Logging: Operational DBAs
DBQL Overview
DBQL Uses
Overview of Collection Options
Logging Rules for Applications
Best Fit Rule Hierarchy
Rules Validation
SQL Logging Statements
SQL Logging Considerations
XML Query Plan Logging
Capturing DBQL Using Account String
SQL Logging by Workload Type
SQL Statements to Control Logging
BEGIN/REPLACE/END QUERY LOGGING Statements
WITH Logging Options
LIMIT Logging Options
Mode Logging Option
DBQL Macros
DBQL Tables
DBQL Views
Shredding the Lock Plan Information in the XML Lock Log Table, DBQLXMLLockTbl
Output of Shredding
Shredded_LockTbl: Blocking Transaction Lock Shredding Target Table
Investigating Deadlocks: Querying Shredded_LockTbl
Shredded_TransTbl: Blocked Transaction Lock Shredding Target Table
Query Data Storage and Protection
Things to Consider When Logging DBQL Data
Logging Overhead
Options for Flushing the DBQL Cache
Flushing the DBQL Caches Manually
Changing the DBQL Performance Stats Cache Size
Logging Scenarios
Scenarios of Logging Accounts
Scenarios of Detailed Logging
Scenarios of Threshold and Summary Options
Example: OBJECT Data for One Query
Example: STEP Data for One Query
Examining the Logged Data
Comparing CollectTimeStamp Value between Tables
Using QueryID for Joins on DBQL Tables
Maintaining the Logs
Methods for Minimizing Log Table Size
DBQL Objects You Cannot Change
Reviewing or Ending Current Rules
Reviewing Rules
Changing DBQL Rules for Specific Users or Accounts
Ending DBQL Logging for Specific Users or Accounts
Ending All DBQL Logging
Effects of Dynamically Enabling/Replacing/Disabling Logging on Current Rules
Granting DBQL Administrative Privileges to Other Users
Analyzing Requests and Request Plans: Application DBAs
Using EXPLAIN to Analyze Request Plans
EXPLAIN Request Modifier
Generating an EXPLAIN with Teradata Studio
Generating an EXPLAIN with BTEQ
Capturing Request Plan Steps
Query Capture Facility
Capturing Request Plans Using DBQL
Relationship between BEGIN QUERY CAPTURE and BEGIN QUERY LOGGING
Query Capture Database
Creating the Query Capture Database Tables
Creating QCD Tables
Creating the Query Capture Database Tables Procedure Using BTEQ
Dropping Query Capture Database Tables
Dropping Query Capture Database Tables Procedure Using BTEQ
Querying QCD Tables
QCD Request Macros and Views
QCD Macro and View Versions
User Categories
Specific User Category Privileges
Building Baseline Transaction Profiles
Using Maps to Position Table Data across AMPs: All DBAs
Map Overview
Scenarios for Using Maps to Move Table Data
Initial Setup for Managing Maps
A Simple Process for Changing the Map for a Table
Analyzing and Optimizing Map Placement
Introduction to the Advisor and Mover Tools
Enabling Step Logging to Aid in Map Analysis
Excluding Objects from Map Reassignments
Analyzing Maps
ActionsTbl
Reviewing Recommended Map Actions
Customizing the List of Recommended Map Actions
Renaming Maps after a System Expansion
Sessions Used for Reassigning Maps
Estimating the Time Needed to Reassign Maps
Decisions Required before Reassigning Maps
Reassigning the Map for a Table
Limiting the Resources for Map Reassignments
Stopping the Map Reassignments Gracefully
Stopping Map Reassignments Abruptly
Managing Restarts
Restart Cleanup during the Advisor Process
Restart Cleanup during the Mover Process
Other Cleanup Tasks
Handling a Second Contiguous Map after a System Expansion
Removing Historical Data
Adjusting Space Limits and Skew Settings
Setting Up Database Query Logging
Performance Effects of Query Logging
Performance Information in DBQL Tables
Recommended DBQL Logging Scenarios
DBQL Collection Recommendations
Using DBQL Tables
Collecting Useful DBQL Historical Data
Teradata System Limits
System Limits
Miscellaneous System Limits
Message Limits
Storage Limits
Gateway and Vproc Limits
Hash Bucket Limits
Database Limits
Name and Title Size Limits
User Limits
Table and View Limits
Spool Space Limits
BLOB, CLOB, XML, and Related Limits
Macro, UDF, SQL Procedure, and External Routine Limits
Query and Workload Analysis Limits
Secondary and Join Index Limits
Reference Index Limits
SQL Request and Response Limits
Row-Level Security Constraint Limits
Session Limits
Teradata Crashdumps
Password Restricted Words
Frequently Used Words
Frequently Used Names
Database Design
Database Design for Vantage
Analytics Database
Data Placement to Support Parallel Processing
Row Distribution
Shared-Nothing Architecture
AMP Ownership of Data
Other Applications of Hashing for Parallel Processing
Synchronization of Parallel Operations
Synchronized Table Scans
Spool Reuse
Synchronized BYNET Operations
Design Considerations
Usage Considerations: OLTP and Data Warehousing
Usage Considerations: Summary Data and Detail Data
Usage Considerations: Simple and Complex Queries
Usage Considerations: Ad Hoc Queries
Databases and Data Modeling
Database Design Life Cycle
Designing for OLTP and Designing for Data Warehousing Support
ANSI/X3/SPARC Three Schema Architecture
High-Level Architecture
Detailed Architecture
Requirements Analysis
Logical Database Design
Activity Transaction Modeling
Physical Database Design
Indexes and Maps
Primary Indexes and Primary AMP Indexes (Overview)
Data Access Considerations for Choosing a PI or PA
Data Distribution Considerations for Choosing a PI or PA
Unique PIs
Nonunique PIs and PAs
Joins and Colocation
Tables with No Primary Index
Secondary Indexes (Overview)
Join Indexes (Overview)
Hash Indexes (Overview)
Index Considerations
Index Type Comparisons
Evaluating Indexes
Maps
Primary Index, Primary AMP Index, and NoPI Objects
Primary Indexes and Primary AMP Indexes
Primary Index Defaults
Unique and Nonunique Primary Indexes
Partitioned and Nonpartitioned Primary Indexes
Nonpartitioned Primary Indexes
Partitioned Primary Indexes
Partitioning Expression Data Type Considerations
Column Partitioning a Table or Join Index
Choosing an Indexing Method for a Column-Partitioned Table or Join Index
Benefits and Considerations for Column-Partitioned Tables with a Primary AMP Index
Benefits and Considerations for Column-Partitioned Tables with a Primary Index
NoPI Tables, Column-Partitioned NoPI Tables, and Column-Partitioned NoPI Join Indexes
INSERT ... SELECT into NoPI Tables
Uses for Nonpartitioned NoPI Tables
Rules and Limitations for NoPI and Column-Partitioned Tables
Manipulating Nonpartitioned NoPI Table Rows
Column Partitioning
Options for Storing Data on an AMP
Column-Partitioned Tables
Column Partitioning Performance
Cases Where Positive Performance Effects Are Most Likely to Occur
Cases Where Negative Performance Effects Are Most Likely to Occur
Autocompression
Examples
Autocompression and Spools
Autocompression Interactions with User-Specified Compression Methods
Checking the Effectiveness of Autocompression
Using the NO AUTO COMPRESS Option
Anticipated Workload Characteristics for Column-Partitioned Tables and Join Indexes
General Performance Guidelines for Column Partitioning
Guidelines for Queries, Contexts, and Table Maintenance for Column Partitioning
Guidelines for Partitioning Column-Partitioned Tables and Join Indexes
Guidelines for Specifying Table and Column Attributes for Column Partitioning
Guidelines for Specifying Compression for Column-Partitioned Tables and Join Indexes
Guidelines on Optimizing I/O Operations, CPU Usage, and Disk Space Usage for Column-Partitioned Tables and Join Indexes
Guidelines for Collecting Statistics on Column-Partitioned Tables and Join Indexes
Deleting Rows from a Column-Partitioned Table
Updating a Column-Partitioned Table
Operations and Utilities for Column-Partitioned Tables
Storage and Other Overhead Considerations for Partitioning
Advantages and Disadvantages of Partitioned Primary Indexes
Usage Recommendations for Row Partitioning
Row Partition Elimination
Basing Partitioning on Modulo Partitioning of a Numeric Column
Basing the Partitioning Expression on Two or More Numeric Columns
Basing the Partitioning Expression on a CASE_N Function
Considerations for Basing a Partitioning Expression on a CASE_N Function
Basing a Partitioning Expression on a RANGE_N Function
Considerations for Basing the Partitioning Expression on a RANGE_N Function
Basing the Partitioning Expression on a RANGE_N Character Column
Using CASE_N and RANGE_N in SELECT Requests
Workload Characteristics, Queries, and Row Partition Elimination
Workload Characteristics and Row Partitioning
Workload Characteristics and Partitioning
Workload Characteristics and Joins
General Recommendations for Using Row-Partitioned Tables and Join Indexes
Single-Level Partitioning
Partitioning CHECK Constraints for Single-Level Partitioning
Single-Level Partitioning Example
Stage 1: First single-level partitioning of the orders table
Stage 2: Second single-level partitioning of the orders table
Stage 3: Third single-level partitioning of the orders table
Stage 4: Fourth single-level partitioning of the orders table
Single-Level Partitioning Case Studies
Multilevel Partitioning
Partitioning CHECK Constraint for Multilevel Partitioning
Partitioning CHECK Constraints
Row Partition Elimination with Multilevel Partitioning
Importance of Partition Order for Specifying Partitioning Expressions
Multilevel Partitioning Example
Stage 1: First multilevel row partitioning of the orders table
Stage 2: Altering the row partitioning expressions
Three-Level Row Partitioning Example
Combined Partitioning Expression for the Sales Table
How Rows for the Sales Table Are Grouped on an AMP