Teradata Studio

Tools
Tools covers the tools and utilities you use to work with Teradata and its supporting ecosystem. You'll find information on everything from the Teradata Eclipse plug-in to load/extract tools.
Highlighted
Teradata Employee

Teradata Studio

Teradata Studio is a client based graphical interface used to perform database administration tasks on the Teradata Database. Teradata Studio is built on the Eclipse® Rich Client Platform (RCP), taking advantage of the RCP framework for building and deploying native GUI applications. It extends the Eclipse Data Tools Platform (DTP) to enhance Teradata Database access. Teradata Studio can be run on Windows, Linux, and Mac OSX operating systems. The Eclipse platform is designed as an open tools platform but architected so that its components (or a subset of its components) can be used to build RCP applications. This allows Teradata Studio to benefit from the many high quality Eclipse features available while focusing on value-add for Teradata.

With the Studio 15.11 release, a new user interface was introduced in the Administration Perspective. Refer to the article, New Studio Administration User Experience for more information.

In addition to this article, there is a Teradata Studio User Guide document now available on the Teradata Studio Download page.

Teradata Studio includes the following key features:

  • Task-based Perspective Display.
  • Modular display that allows you to move panels around, creating a custom look and feel.
  • Connection Profile Wizard to create connection profiles using the embedded Teradata or Aster JDBC Driver or Hadoop connection service.
  • Data Source Explorer to view database objects, such as databases, schemas, tables, macros, stored procedures, map reduce functions, user-defined functions, user-defined types, views, and triggers.
    • Add Database - Allows you to add a single Teradata Database or User to the DSE tree, one at a time.
    • Set Root - Allows you to set the root of a hierarchical tree display.
    • Create Filter - Allows you to filter out objects from the Data Source Explorer folders.
  • SQL Editor to create, modify, format, and execute SQL queries.
  • SQL Query Builder to visually build and edit SQL queries (Teradata only).
  • AutoCommit options allows user to manually control autocommit of SQL Statements.
  • Result Set Viewer that displays result set data, allowing the user to select rows and cells, copy and format data, sort, hide, and move columns, and search for result set data values
  • Export Result Sets to Excel, XML, or text files
  • SQL History to maintain a historical record of submitted SQL queries with timings and status information
  • Object List Viewer to display the list of objects and open forms to display more detail information about Databases, Users, Schemas, Tables, Views, Macros, Stored Procedures, User Defined Functions, User Defined Types
  • Drop Databases, Schemas, Tables, Views, Stored Procedures, Macros, or User Defined Functions
  • Data Transfer Wizard to transfer table data between Teradata, Aster, Hadoop, and the external file system.
  • Data Export wizard to extract data from the Teradata or Aster Database to a file on the desktop.
  • Data Load wizard to load data from the desktop file system to the Teradata or Aster Database.
  • Smart Loader to easily load delimited text or Excel files into Teradata or Aster.
  • Table Data Editor to easily Update, Insert, or Delete data for a table.
  • Transfer History View to display the information about data transfers.
  • Copy Object Wizard to copy Teradata objects from one Teradata system to another.
  • Hadoop Transfer Wizard to transfer Hadoop tables between Teradata and Hadoop (aka Smart Loader for Hadoop).
  • Compare Objects Wizard to compare two Teradata or two Aster (6.10) database object definitions
  • Generate DDL to display the DDL for a given database object and its contained objects. This feature is provided in Teradata and Aster 6.10.

Teradata Database Only Features -

  • Teradata Administration forms to create and view Teradata objects: Databases, Users, Tables, Views, Stored Procedures, and User Defined Functions
  • Dialogs to create User Defined Types
  • Modify and Drop Actions: Databases and Users
  • Administer Roles and Profiles
  • Grant or Revoke of access and system rights
  • Manage Privileges on database objects
  • Copy Table, View, Stored Procedure, Macro, or User Defined Type definitions to another database, or to another system
  • Rename Tables, Views, Stored Procedures, Macros, or User Defined Functions
  • Data Source Explorer menu options to run Stored Procedures, Macros, and User-defined Functions
  • Move space from one database to another
  • Find objects in the Data Source Explorer
  • Set up the rules for Query and Access Logging
  • Administer Foreign Servers (Create, Drop, Alter, and View)
  • Administer Secure Zones (Create, Drop, Modify, and add Zone Users)

Aster Database Only Features -

  • Aster Administration forms to create and view Aster objects: Databases, Users, Roles, Schemas, Tables, and Views
  • Grant and Revoke Privileges for Aster objects
  • Aster Analytical Templates that provide the SQL syntax for the support analytical functions within Aster.

For administrative functions, Teradata Studio will provide a preview of the SQL statements and allow the user to save the SQL to a file or display it in the SQL Editor.

Usage Videos

For detailed step-by-step demonstration of the Studio features, refer to the Studio Usage Videos article.

Studio Perspectives

A perspective is a visual container for a set of views, menus, toolbars, and actions.  Each perspective provides a set of functionality aimed at accomplishing a specific type of task or works with specific types of resources. Teradata Studio includes three perspectives: Query Development, Administrator, and Data Transfer. The Query Developement perspective focuses on SQL query developement tasks. The views displayed within the Query Development perspective include the Data Source Explorer, Project Explorer, SQL Editor, Result Set Viewer, and SQL History View. The topmost menus provide the user with tools to create and edit SQL statements.

The Administration perspective focuses on database development and administrative tasks for your Teradata Database.  The Administration perspective includes the Navigator View, the Filter View, and the Object List Viewer. The Navigator View allows you to select the connection profile for administering objects. The Filter View allows you to filter the objects displayed in the Object List Viewer. The Object List Viewer provides a list of the objects and 'Open' actions to view more detailed information about the objects. The Object List Viewer toolbar and menus include actions to create and administer database objects.

The Data Transfer perspective provides support for transferring data and objects in Teradata and Aster Databases, and Hadoop systems. The Data Transfer perspective includes the Data Source Explorer, Transfer View, Teradata Progress View, and Transfer History View. The Transfer View provides a drag and drop palatte for copying table objects between Teradata and Hadoop systems and copying all objects between Teradata systems. The Progress View shows the status of active data transfer jobs. When the data transfer job completes, an entry is stored in the Transfer History View.

Modular Display

As mentioned above, within each of the Studio perspectives are views that provide the modular display for the perspective.

The Data Source Explorer View panel contains the database object tree display. It is here that you can create connection profiles to your Teradata Database, Aster Database, or Hadoop systems and interact with the database objects.

The Project Explorer View panel provides a hierarchical view of the Projects and their resource files It is here that you can select SQL files for editing or create new SQL files.

The SQL Editor is displayed when a SQL file is opened. Initially, the SQL Editor is opened to provide an area to enter SQL statements. The user must provide a connection profile in order to execute the SQL statements. Double clicking on a file in the Project Explorer will cause the file to be opened in the SQL Editor View.

The Teradata SQL History contains the history information when executing SQL statements and running database routines, user-defined functions, and triggers.

The Navigator View provides a hierarchical tree view of a selected connection profile with categories of objects to display in the Object List Viewer.

The Filter View allows users to create filters to confine the list of objects displayed in the Object List Viewer.

The Object List Viewer displays a list of objects based on the category selected in the Navigator. Toolbar and menu actions are provided to display more detailed information about database objects or create and modify database objects.

The Teradata Result Set Viewer displays the result set data. Individual Result Set tabs are created for each result set. The Result Set Viewer also contains a toolbar with actions that can occur on the result set data, such as saving, exporting, or printing the result set data.

The Transfer View provides a mirror display of the Data Source Explorer object tree and used to drag and drop database tables or objects for copying from one system to another.

The Teradata Progress View provides a display of the active data transfer jobs.

The Transfer History View provides a display of the completed data transfer jobs.

Studio Toolbars

Teradata Studio contains a toolbar that provides buttons to allow quick access to dialogs for creating database objects or invoking functions that are used while creating and modifying SQL files.

Teradata Studio toolbar is divided into the following sections:

File Actions: The File Actions toolbar buttons are used when editing a SQL file. They include Save, SaveAs, Cut, Copy, Paste, Undo, Redo, Print, and Show Whitespace.

SQL Tools Toolbar — The SQL Tools toolbar buttons are used to perform actions on the SQL statements within the SQL Editor. They include Execute as Individual Statements, Execute as One Statement, Execute a Single Transaction (Aster Only), Explain, Format, Prompt for Notes, Code Assist Auto-activation. SELECT Statement and SHOW DDL(Teradata Only) are activated when a table is selected in the DSE.

Data Tools Toolbar — The Data Tools toolbar buttons provide actions that are performed on a database table, such as Show Row Count, Teradata Load, and Teradata Export. Teradata Load and Export are enabled for Teradata Connections only.

Artifact Maintenance Toolbar - The Artifact Maintenance toolbar buttons provide actions to Move Space from one database to another, Copy and Compare objects, Rename objects, Drop objects, and Delete Databases. These actions are enabled for Teradata Connections only.

Find Actions Toolbar - The Find Actions toolbar provides quick access to the Find Object and Find Next Object. These actions are enabled for Teradata Connections only.

Navigation Toolbars — The Navigation toolbar buttons are used to reference locations within the SQL file. They include Next Annotation, Previous Annotation, and Last Edit Location.

A view can also contain its own toolbar and drop down menu. These toolbar buttons and menu items provide actions on the data managed by the view. Included in the view toolbar are buttons to minimize, maximize, and restore the view. Maximizing the view will cause the view to take over the entire Teradata Studio window display. Click the Restore button to return the view back to its previous display.

Customize the Display

You can customize the look and feel of Teradata Studio by moving view panels within the main display window. A view can be moved by selecting the view and dragging it to a new location. As you move the view over the display, the mouse pointer will change depending on where you want to drop or dock the view. You can also drag the view outside the display area. The view will then become a "detached" view. You can also remove a view panel by clicking the "X" on the view tab. A view can be re-displayed by selecting the view from the Window>Show View option in the main menu. Or to return the perspective and views to their original display, select the perspective, then click Window>Reset Perspective...

You can also customize the Toolbars, Menus, and Command Groups of the display. Choose the Customize Perspecive... option from the Window menu.

The Customize Perspective dialog is presented for you to choose the Toolbar buttons, Menu options, or Command Groups you would like to change. Un-select the buttons or options so that they are not shown in the Teradata Studio's Query Development perspective.

You can customize the toolbar and menu items in the Object List Viewer via the Object List Viewer preference page. Uncheck the actions or action groups that you do not want to display. You can also change the double-click action in the Menu tab by right clicking on the action and choose 'Set as Double-Click Action'.

Creating Connections

You can create connections to your database using the Connection Profile Wizard. The wizard is invoked from the Data Source Explorer by right clicking on the Database Connections folder or selecting the 'New Connection Profile' button, , from the Data Source Explorer toolbar.

          

Studio provides an option to create connection profiles for additional database servers other than Teradata.  You must provide the specific database server's JDBC driver for databases other than the default connection profile types: Teradata Database, Aster Database, or Hadoop Systems. Refer to the section, Connecting to Non Teradata Database, for configurating connections to Oracle, DB2, or SQL Server.           

Select Teradata Database from the Connection Profile Types, enter a Name and click Next.

 

The Connection Profile Wizard is based on a driver template that references an embedded Teradata JDBC driver. Enter the database server name, user name, password, and default database name into the wizard dialog screen. The Authentication Mechanism allows you to choose an advanced logon mechanism, such as LDAP or Kerberos, or select the default mechanism, PASSWORD_PROTECTED. If you wish to save your password to disk, check the Save Password box. Otherwise, the password is stored in the profile and only active throughout the Teradata Studio Express session. When Teradata Studio Express is closed, the unsaved password is removed before the profile is written to disk. You will be prompted for the password the next time you connect.

Optionally, you can choose a different Teradata JDBC driver than the embedded Teradata JDBC driver. You can also add or remove the JDBC properties, as well as save the properties to an external file. The external file is called jdbcConnectionProperties.properties and located in the workspace .metadata/Teradata directory. The jdbcConnectionProperties.properties file allows you to share a set of JDBC properties with other Teradata Studio Express users. If the file exists when creating a new Teradata connection profile, it will load those property values into the list of JDBC connection properties. If the file exists but it is empty, the connection wizard will assume that no JDBC properties are specified and the Teradata JDBC driver will use the default settings.

NOTE: In Studio, the default Teradata Mode (TMODE) is set to ANSI and the default TMODE setting with SQL Assistant is TERA. As the recommended TMODE setting is ANSI, users can change the TMODE to TERA. To change the TMODE property, press the Add button and select the property TMODE. Choose the property value TERA and click OK to replace the existing TMODE property. Please refer to the Teradata Documentation (SQL Request and Transaction Processing) for differences between Teradata and ANSI Session Modes. One particular difference is that by default, character comparisons are always CASESPECIFIC in ANSI session mode, where character comparisons are always NOT CASESPECIFIC in Teradata session mode.

Once you have changed or added new JDBC Properties, you can set your new properties as the default properties for any new connection profiles by clicking the Save Properties button. This will save the properties to a file in your workspace called jdbcConnectionProperties.properties located in your workspace in the <WORKSPACE>/.metadata/Teradata directory.

You can also cache schema metadata, saving time when loading the database objects in the Data Source Explorer. Click the Cache Properties button to select schemas (or databases) to cache.

              

Aster Connection Profiles are created using a similar connection wizard with the embedded Aster JDBC Driver. Database server name, user name, password, port number, and database name fields are provided for user input. You can also cache Aster Database schema metadata to save time loading the Aster database objects in the Data Source Explorer.

There are three options for creating Hadoop Connection Profiles:

  • Hadoop Generic System - The Hadoop Generic System profile supports migrating Hadoop connections from Studio releases prior to Studio 15.10. It is also used to support Cloudera Hadoop connections.  Hadoop Generic System connections are created using the WebHCat protocol to connect and discover database and tables information. It requires that the ConfigureOozie script is run on the Hadoop System.

             

  • Hadoop Hortonworks - The Hadoop Hortonworks connection profile provides additional options for connecting to Hortonworks Hadoop systems. It is based on the desired functionality between Studio and your Hadoop System: Knox Gateway (Secure connection), TDCH (Teradata data transfers), JDBC (creating and running SQL), or SQL-H (Hadoop to Aster data transfers). Note that the Knox Gateway option also supports JDBC connections. Click next to enter the Host name, Port number, User name, and Password, if required. The TDCH option is equivalent to the Hadoop Generic System connection profile described above.

            

  • Hadoop Cloudera - The Hadoop Cloudera connection profile provides additional options for connecting to Cloudera Hadoop systems. It is based on the desired functionality between Studio and your Hadoop System: TDCH (Teradata data transfers), JDBC (creating and running SQL), or SQL-H (Hadoop to Aster data transfers). Note that Cloudera uses the Impala JDBC driver that is bundles with Studio. Click next to enter the Host name, Port number, User name, and Password, if required. The TDCH option is equivalent to the Hadoop Generic System connection profile described above.     

            

Data Source Explorer View

The Data Source Explorer View panel contains the database object tree display. It is here that you can create connection profiles to your Teradata Database, Aster Database, or Hadoop systems and interact with the database objects. The Data Source Explorer view provides a hierarchical view of Teradata Database objects, nesting child databases and users within the parent database or user. Preferences are provided that allow you to choose which objects to load and display in the Data Source Explorer.

                  

Displaying Multiple Connections

With Studio, you can display multiple connection profiles going to the same (or different) Database Server(s). This is useful when you want to compare the database objects or, for the same Database Server, use filters to control what database objects are displayed in one connection profile versus the other. For example, one connection profile may require quering your metadata databases and include filters to just include those databases. And the other connection profile (to the same Database Server) is used for activities that involve a semantic layer so provide a filter to just include those databases.

          

Connecting to Non Teradata Database

In Studio, the default database types are Aster, Hadoop, and Teradata. To connect to DB2, Oracle, or SQL Server, the user would do the following:

  1. Go to Window>Preferences>Teradata Datatools Preferences>New Profile Connection Types and enable the non Teradata connection type in the New Profile Connection Types list. The default values are Aster Database, Hadoop System, Hortonworks, and Teradata Database. In the screen capture below, we have checked the Oracle connection type.

        

  1. Press the New Connection Profile and choose Oracle. Enter a Name for the connection profile and press Next.

           

  1. Click the 'New Driver Definition' button,  and create an Oracle Driver definition.

        

  1. Choose the Oracle Database and enter a Driver name, then click the JAR List tab to specify the location of the Oracle JDBC driver. Note: You must download from Oracle the Oracle JDBC driver and place it on your desktop. Then press the Add JAR/Zip... and specify the location of the JDBC driver jar.

          

  1. Click OK to return to the New Connection Profile Wizard. Here you will specify the SID, Host, User name and Password, as well as any optional JDBC properties. Click the Test Connection button to test the connection, then click Finish to create the connection profile and return to Studio Express.

           

Add a Database

In Studio, the Data Source Explorer view provides the database tree with its database objects presented in folders, such as Databases, Tables, Macros, Views, etc. By default, the database tree is presented in a hierarchical display with child databases and users nested under their parent database or user. Also, by default, all of the database and users are displayed. To change this and only add one database at a time, the user would follow these steps:

  1. Go to the Data Source Explorer Preference page and uncheck the option 'Show Databases and Users in Hierarchical Display'
  2. Select the 'User Choice' option.

        

  1. Return to the Data Source Explorer, right click on the Databases folder and choose Teradata>Load Database...

         

  1. This will invoke the Add Database dialog. Enter the name of the database or user you wish to add and click the Add button. You can repeat this process, adding additional names. Close the dialog when all names have been added.

        

  1. The Databases folder is refreshed and the newly added database or user is loaded in the Data Source Explorer.

        

Set Root for Database Tree

Another option provided in Studio is to set the Root location for the database tree. If you would prefer to display the database tree in hierarchical format (nesting child databases and users) but still reducing the number of databases and users displayed in the tree, you can set the Root of the database tree. This will restrict the display to your database or user and its child databases and users. For this option:

  1. Go to the Data Source Explorer Preference page and choose the 'All Database and Users' option and check the option 'Show Databases and Users in Hierarchical Display'
  2. Next, return to the Database Source Explorer and right click on the Databases folder and choose Set Root...

    

  1. This will invoke the Set Root Database dialog. Enter the Root database or user name and click OK.
  2. The Databases folder is refreshed and the ROOT is set to the value specified.
  3. Open the root database or user and any nested child databases or users are loaded in the Data Source Explorer.

      

Creating Database Tree Filter

Studio allows you to set a filter on the folders displayed in the Data Source Explorer (DSE), filtering out unwanted database objects. This applies to not only the Databases folder, but also the Tables, Views, Stored Procedures, and User Defined Functions. Setting a filter on the Database folder is another way to control what databases you see in the DSE. The following are the steps to create a filter:

  1. Right click on the DSE folder and choose the Filter... option.  This will invoke the Filter Dialog.

   

  1. Next, in the Filter Dialog, uncheck the 'Disable filter' option and choose Expression or Selection. The Expression option allows you to choose between such expressions as: 'Starts with the characters', 'Contains the characters', 'Ends with the characters', 'Does not start with the characters', 'Does not contain the characters', and 'Does not end with the characters'. The Selection allows you to choose the objects from the list to be included or excluded in the display.

     

  1. Click OK to reflect the filter in the DSE tree.

      

Creating Database Objects

You can easily create database objects in your Teradata Database using the Teradata Studio administration forms. First, switch to the Teradata Administration perspective to access the create and modify actions. The forms are accessed from the Object List Viewer toolbar and menu actions. For example, to create a new Table, choose (double-click) the Databases category in the Navigator. Locate the database in the Object List Viewer that you wish to create the table in and double-click. This will show you the list of tables and provide a toolbar action "Create Table''.

This will open a new 'Create Table' form below the Object List Viewer. First, in the General tab, enter a name for the table. Then select the Columns tab, press the Add button to add columns for your table.  Enter a column name and select the column type. The drop down list will present the list of valid column types for the Teradata version you are creating your table in.Click Add to create another column definition. Next, choose the column Groupings, Indexes, Constraints, or additional information for the table. Lastly, select the SQL tab to view the generated SQL. Press the Commit toolbar button o execute the CREATE TABLE statement. This will create the table in the database and cause the list of tables to be refreshed in the Object List Viewer.

Creating a SQL Statement (SQL Editor)

When Teradata Studio is launched, a SQL Editor area is provided for you to enter your SQL statements. First switch to the Query Development perspective. Once you have a connection to your Teradata or Aster database or Hadoop JDBC system, you can begin to enter SQL statements in the SQL Editor window.  Click the Save to Project button to save the SQL Editor to a file in the workspace or Export to File System to export the file to the desktop file system.

           

Another option to create a SQL file is through the Data Source Explorer. Within the Data Source Explorer, select your database connection and click the SQL Editor icon, , from the Data Source Explorer toolbar. This will create a SQL file in the SQL Editor with the name 'SQL Editor [n]' and the connection profile set to your database connection. You are now ready to enter your SQL statement. 

You can also open an existing SQL file, located in the Project Explorer, into the SQL Editor and associate it with a connection profile. SQL files can be imported into the Project Explorer from your local desktop file system. Right click on the SQL project and choose the Import menu option.

               

The SQL Editor provides a scratchpad for you to enter your SQL statements. As an option, you can enable the auto activation of code assist by clicking the  toolbar button. If this option is enabled, as you type your SQL statement, code assist will pop up annotations showing a list of expected keywords. If a database name is entered followed by a dot, the content assist will display the list of tables from your database for you to select from. (Note: By default, auto activation of code assist is disabled. Also, you must select a Teradata or Aster Database connection profile type in order for SQL code assist to work.)

Code assist will also provide a list of SQL Templates. At the start of the SQL statement, hit the Cntrl+SPACE keys and a pop up list of templates is displayed. Scroll down until you find the template you want and double click on it to insert the template into your SQL Editor file. Anchor fields are provided that you can navigate by tabbing. You can also edit or add your own SQL Templates via the SQL Editor Preferences page.

Parameterized queries can also be created in the SQL Editor. The query contains parameters indicated by question marks. When the query is executed, the user is prompted for the parameter value(s) in the Configure Parameters dialog. Named parameters (appending backslash ,'\',<parameter name>) allows the user to specify a name for the parameter. When the Configure Parameters dialog is presented, the parameter names will be used to reference the parameters.

           

          

The SQL Editor also provides syntax coloring for your SQL statements. You can change the colors of comments, keywords, identifiers, types, or other syntax items via the SQL Editor Preferences page.

When right clicking in the SQL Editor window, a SQL Editor Context menu appears with options to execute the SQL statement(s) in your SQL file.

                 

The following options are presented:

  • Execute all of the SQL statements
  • Execute the selected SQL statement
  • Execute the SQL statements as individual statements (with a commit occurring between statements)
  • Execute the selected statement as one statement
  • Execute the current statement where the cursor is located
  • Execute the SQL statements as a single transaction (Aster only)
  • Visual Query Builder (Teradata only)

You can also choose the Execute options from the SQL Editor or top level toolbar, , .

Manual commit and rollback of the SQL Execution is also provided via SQL Editor toolbar options.

An Autocommit checkbox is provided in the SQL Editor to allow the user to toggle Autocommit on or off. By default, Autocommit is ON. If the option is turned off, then the Commit and Rollback options are enabled for the user to manually control the commit of their SQL statements to the database or rollback if an error occurs.

SQL Query Builder

Teradata Studio provides a graphical interface for creating SQL statements for Teradata, referred to as the SQL Query Builder. You can edit an existing statement using the SQL Query Builder by selecting the statement within the SQL Editor and choosing the ‘Edit in SQL Query Builder…’ menu option. (Refer to figure above).

    

In addition, you can open a SQL file in the SQL Query Builder via the Project Explorer menu item, Open With...>Teradata SQL Query Builder.

This option will open the SQL Query Builder inside the SQL Editor view. This allows you to drag and drop the table objects from the Data Source Explorer into the diagram area of the SQL Query Builder.

You can also add additional tables and table joins by right clicking in the SQL diagram area and select Add Table or Create Join options. When adding a table, a list of tables and views is presented for you to choose from. Click OK to save your SQL statement back to the SQL Editor.

Data Transfer Wizard

Teradata Studio supports Teradata's Unified Data Architecture (UDA) by providing access to Teradata, Aster, and Hadoop via a single client tool. The Data Transfer Wizard provides a single dialog for transfering data between Teradata, Aster, Hadoop, and the external file system.

              

You can use the Data Transfer Wizard to invoke the Smart Loader on Teradata or Aster Databases, load or export table data for Teradata or Aster Databases, and Copy table objects and data between Teradata Databases or between Teradata databases and Hadoop systems or Hadoop systems and Aster Databases.

      

For example, when choosing to transfer data from a Teradata table, the Data Transfer Wizard will provide options to transfer the data to various destinations, such as: exporting to an external file, transfering to another Teradata system or table, or transfering to Hadoop.

Extract and Load Data

The Data Source Explorer provides an option to extract and load data for Teradata and Aster tables using Load Data Wizard and Export Data Wizard. Large Teradata tables and files will use the JDBC FastLoad or FastExport option depending on the number of rows and column data types supported. Otherwise, the JDBC load batch interface is used, and as well for Aster tables. Right click on the table and select the option from the Data drop down context menu.

             

Selecting the Load Data... option invokes the Data Transfer Wizard. If you are not in the Data Transfer Perspective, you will be prompted to switch to the Data Transfer Perspective where the Teradata Progress View and Transfer History View are displayed.

                  

The Data Transfer Wizard will provide the list of sources for the table load. Choose the External File option to launch the Load Data Wizard.

               

The Load Data Wizard will prompt the user for the file to load and define the necessary file format needed to identify columns when loading data into the table. File format options include the column delimiter (comma, semicolon, space, tab, fixed width, or vertical bar “|”) along with the character string delimiter (double quote, single quote, or none), OS Line Separator, File Encoding, and starting row number. If data already exists in the table, the load data will append or replace the existing data. You can also indicate whether column labels are in the first row, as well as whether to lock the table during the load process.

A preview of the input file is also provided, using the file options specified. This will help you make sure you have the correct file options before starting the load.     

   

Selecting the Export Data option invokes the Data Transfer Wizard with the list of destination options for exporting the data to. Choose the External File to launch the Export Data Wizard.

              

The Export Data Wizard prompts the user for similar information as the Load Data Wizard. Choose the Output File, File Type and File Options.

               

The status of the data load or export job is displayed in the Transfer Progress View. When the job has completed, an entry is placed in the Transfer History View. Refer to the section below regarding the Transfer History View.

Smart Loader

The Smart Loader feature allows the user to load a text delimited or Excel file into a Teradata or Aster table. The Smart Loader is invoked from the Tables folder within the destination database via the Data Transfer Wizard.

        

From the Data Transfer Wizard, choose the Source Type as External File (Smart Load) to launch the Smart Load Wizard.

        

Like the other load data utilities, the Smart Loader will prompt the user for the input file.

         

Next, the Smart Loader will scan the file to determine the "best" column types and present these to the user.

          

Clicking the ellipses button (...) provides an option to modify the column definition.

          

Next, the table DDL is presented. The user can choose the 'Show in Editor' option to save the table DDL to the SQL Editor and manually change the table definition. Otherwise, clicking Finish will execute the DDL statement and begin loading the data into the newly created table.

         

The status of the Smart Load job is displayed in the Transfer Progress View. When the job has completed, an entry is placed in the Transfer History View.

Transfer History View

The Transfer History View displays the information about the data transfer, such as the name (given by the Export, Load, or Copy wizards), timestamp, source and destination systems, status, duration, rows transfered (if known), note, and summary. This information is stored in an embedded Derby database. You can sort and filter the rows and columns, edit the name or note. The data transfer job can be re-executed by selecting the entry and pressing the Re-execute toolbar button. The output of the transfer data job is displayed by pressing the Job Output button.

Copy Object Wizard

The Copy Object Wizard allows you to copy Teradata database objects from one Teradata Database system to another. Click here to view the Copy Object Wizard article and read more about copying Teradata database objects.

Hadoop Transfer Wizard (aka Smart Loader for Hadoop)

As with the Teradata Copy Wizard, you can transfer tables between Teradata Databases and Hadoop Systems or Hadoop Systems and Aster Databases. And, as with the Teradata Copy Wizard, there are two ways to invoke the Hadoop Transfer Wizards, drag and drop between the Data Source Explorer and the Transfer View or right click on the table and choose Data>Export Data or Data>Load Data. Click here to view the Smart Loader for Hadoop article and read more about transfering tables between Teradata, Aster, and Hadoop.

Table Data Editor

The Table Data Editor provides an enhanced feature to edit tables within the Data Source Explorer for Teradata and Aster tables. The data in the editor is broken up into pages, which allows for efficiency in updating large tables. Along with the standard insert, update, and  delete, data filtering, sorting, and in-memory filtering are also supported. The user also has the option of exporting the data to Excel or Text files.  It may be advantageous to export the data before it is modified.

The Teradata Table Data Editor is accessed via the Teradata menu. Select the table in the Data Source Explorer and right click and choose the Data>Edit Data... option.

The Table Data Editor will present the current rows of data from the table in a table grid display within the SQL Editor. You can click on a cell in the table grid to modify the cell contents or add a new row by clicking on the <new row> entry. A toolbar contains navigation aids and action buttons to control the row displayed, number of rows per page, page controls, as well as Filter, Sort, and Refresh actions.

Column operations are provided to hide or resize columns, find, replace or show values.    

           

Row operations are provided to copy and paste row data, insert and delete rows, or mark rows for export.

            

Row background colors are used to indicate whether a row has been updated (rose), inserted (yellow), or deleted (grey strike-through). These colors can be changed, along with other Table Editor options in the Table Data Editor Preference Page.

           

Depending on the edit option, a SQL UPDATE, INSERT, or DELETE statement is created. SQL Preview toolbar button, , is provided to show the SQL commands that will be run. Click the 'Commit Changes to the Database' toolbar button, , to run the SQL and commit the changes. A status message is displayed to indicate the actions committed to the database.

Project Explorer View

The Project Explorer View panel provides a hierarchical view of the Projects and their resource files. It is here that you can select SQL files for editing or create new SQL files. SQL files can also be imported from or linked to your file system. When Teradata Studio is first installed, an initial project called 'SQL' is created for you. You can create additional projects using the New>Project... menu option.

               

Within the Project Explorer, you can also choose an option to compare two files. The Compare Option displays the two files side by side with buttons that allow you to jump from one difference to another or move changes from one file to another. This is very handy when comparing SQL files or result set data.

The Project Explorer also provides an option to execute one or more SQL files from list of files.

          

Result Set Viewer

The Result Set Viewer displays the result set or parameter data from executing SQL statements and running database routines, such as stored procedures, macros, user-defined functions, and triggers. The Result Set Viewer provides an enhanced display of the Result Set data. It displays the result sets as tabs within the Teradata Result Set Viewer, allowing the user to select rows or cells from the Result Set data table grid. The Result Set Viewer provides menu options to hide or show all columns, move and sort columns, find a value within the result set data, perform aggregate functions on selected numeric columns, filter column data, format cells, and copy cells. Select a row or cell and right click to display the menu options.

       

Multiple result sets can be displayed as tabs or in a side-by-side sash display.

Large Objects (LOBS) can also be displayed in the Result Set Viewer. When a query result is being processed that contains an LOB result column, a dialog appears for the user to specify where and how to store the LOB values on the file system.

    

A toolbar is also provided with options to rename the Result Set tab, show the SQL associated with the result set, switch the display between text and grid display, switch the display between tabs and side-by-side sash display, and save, export, and print result set data. SQL result data can also be saved to a file within your Project or exported to an external file in the file system.

If the Export or Export All option is chosen, the Export Result dialog is displayed. Select a file name, format, and export options. Then click the finish button to create the exported file. The Save option presents a similar dialog.

    

The following screen capture shows the result data with totals on integer columns as exported to an Excel file.

Result Set Export Mode

Studio provides an option to automatically export result data to an external file.  This will bypass displaying the result set data in the Result Set Viewer and instead invoke the Teradata Export Wizard to send the result set data to an external file. To select this options, go to Window>Preferences>Teradata Datatools Preferences>SQL Handling preference page and set the Results Handler to 'Teradata Export Wizard (File Export)'.

Then enter your SELECT statement into the SQL Editor and click the icon to execute the query. The Export Data wizard appears for you to enter the file options to export the data to. As mentioned above, there is a shortcut to the SQL Handling Preferences page by clicking the preferences icon, , on the SQL Editor toolbar.

SQL History

The SQL History View provides an enhanced display of the SQL History information. As SQL statements are executed from the SQL Editor or functions are run from the Data Source Explorer, an entry is placed in the SQL History. The SQL History view displays the data in a grid format, allowing the user to select rows and cells. The SQL History provides extensive information about the SQL execution, such as execution elapsed time, DBMS time, and fetch time, database server, row count, parameter display for macros and stored procedures, SQL statement, and SQL statement type. It provides options to copy cells or rows, edit the 'Note' or SQL for the SQL History entry, search for result history data, and re-execute SQL statements. Choosing the 'Edit SQL' option will open a SQL Editor file with the selected history entry's SQL statement. This allows users to further fine tune their SQL statements.

The SQL History view also provides a toolbar menu with options to delete rows or all of the history entries, filter columns, format cells, and sort columns, The SQL History uses an embedded Derby Database to manage the SQL History entries.

               

Object List Viewer

The Object List Viewer displays the list of objects and options to 'Open' an object to display more detailed information about the database object. When in the Teradata Administration perspective, select a connection and category from the Navigator View. You can expand the Databases category in the Navigator or drill into the list within the Object List Viewer.

Double-click on a database (or schema) to display the list of tables. Choose the toolbar or menu action to show other objects for a database or schema.

Compare Objects

Teradata Studio provides a wizard to help you compare the DDL of two Teradata or two Aster (6.10) objects. First select the Query Development perspective. Then choose a Teradata or Aster database object in the Data Source Explorer, right click and choose Teradata>Compare With... or, for Aster, choose Aster>Compare With...

This will invoke the Compare Objects Wizard for you to choose the object to compare with. Select the connection profile and database. If you are comparing schemas, tables, macros, views, stored procedures, user-defined functions, user-defined types, or indexes, you will be prompted to select another object of the same type.

If you are comparing database or user objects, click Next to choose child objects that will also be generated for the comparison.

Click Finish to display the two objects in the Compare Editor. The Compare Editor will provide toolbar buttons to navigate differences between elements in the two windows.

Generate DDL

Studio provides an option to generate the DDL for a database object and its contained objects. This feature is provided for Teradata and Aster (6.10). To use this feature you must be in the Administrator perspective. In the Data Source Explorer, select the object you wish to generate the DDL for, right click and choose the Teradata>Generate DDL, or Aster>Generate DDL menu option.

The Generate DDL wizard will prompt you to choose CREATE and/or DROP statements. Next, you will select the contained objects you wish to generate. In the example below, an Aster Schema object was selected in the Data Source Explorer. The user has the option to select MR Functions, Schemas (itself), Tables, and Views to include in the DDL.

Click Next to generate the DDL for the selected object types.

Check the 'Open DDL file for Editing' to save the generated DDL to a Scripte.SQL file in the SQL Editor. Click the Next button to display Summary information, then click Finish to close the Generate DDL Wizard.

Aster Administration

Studio provides an administration user interface for Aster objects: databases, users, roles, schemas, tables, and views. Aster administration is invoked from the Navigator and Object List Viewer. Choose the Administration Perspective and select an Aster connection profile from the Navigator. Choose the category of the object you wish to administer. You can expand the list of Databases and Schemas and double-click to display the list in the Object List Viewer. The Object List Viewer will provide toolbar and menu actions to Open, Create, or Drop objects. To modify an object's privlieges, 'Open' the object and select the Privileges tab.

Aster Analytical Templates

Aster Analytical Templates are provided for Aster users to help with the syntax when writing the SQL for Aster Analytical functions. Below are the steps to display the templates:

  1. You must first switch to the Query Development perspective
  2. Open a SQL Editor for your Aster Database
  3. Go to Window>Show View>Other... and choose General>TemplatesView and click OK

                         

  1. The TemplatesView is opened. You can drag the view to the Data Source Explorer/Project Explorer area so that it displays next to the SQL Editor.
  2. Select a template and you can preview the text in the Preview window below the list of templates.
  3. Double click on a template to copy its text to the SQL Editor window.

Help

Help is provided by clicking on the Help>Help Contents in the main toolbar.

Conclusion

Teradata Studio provides a multi-platform, administration tool for supporting your Teradata Database. Dialogs are provided to guide the user through creating and administering database objects.

To get up and running with Teradata Studio use the Download links above or go to the Tools Download area, pick your OS and take a look at the README.

To ask questions or discuss issues, refer to the Teradata Studio Forum and post your question.

253 REPLIES
Teradata Employee

Re: Teradata Studio

Is there an article available that compares functionalities of Teradata Studio, Teradata Studio Express and Eclipse Teradata plugin products? It appears to me that, they are all based on Eclipse, but instead of being available as modules to add needed functionality to a single Eclipse installation, they are three separate products.
Teradata Employee

Re: Teradata Studio

No, but maybe we need one. :-) All of the products are built from the same code base, so functionality wise the features will all act the same. The main difference is that they are each targeted toward a different user and thus contain a different set of features. Teradata Studio Express is for the SQL users. It is intended to help users manage SQL and their result set data.

Teradata Studio is for administrative users. It includes the same features as Studio Express but also includes dialogs to help users create and manage their database objects, such as Schemas, Users, Tables, Views, Permissions, etc. Teradata Studio Express and Teradata Studio are built as Eclipse RCP so they are a single download and install.

Teradata Plugin for Eclipse includes all of the features including additional features for Java Development and XML Services. It is built as a plug-in and is installed into an existing Eclipse installation. You can install just the needed features (or modules) that you want with Teradata Plugin for Eclipse.
Teradata Employee

Re: Teradata Studio

Thanks for the clarification.

Yes, a short article that compares all Teradata tools (including Windows only tools such as SQL Assistant, TD Administrator and Eclipse based tools) will indeed be useful. Here are some comparison categories that I think will be helpful: targeted audience, capabilities/functionality, platforms supported (Windows/Linux), Teradata versions supported, needed prerequisites (native libraries or pure JDBC drivers etc).

Re: Teradata Studio

Copy keys and copying into excel is really annoying. I can't copy columns directly to excel. I need to export, save file and then view it. Additional steps. Also Ctrl+Insert workaround is not working. Why did they change it?
N/A

Re: Teradata Studio

To copy directly to Excel, go to preferences, Teradata Datatools Preferences, Result Set Viewer Preferences and change the Copy Column Delimiter from the default of Comma Separated to Tab Separated and it appears to work fine, at least in the Mac OSX version.
Teradata Employee

Re: Teradata Studio

I have the very same issue with 'date' format conversion. Thanks for the recommended solution. I will try to test new .ini file very next Monday. So far I found TD Studio very helpful and this 'conversion' error forced me to use SQL Assistant on a side.
Cheers
-=[VH]=-
Fan

Re: Teradata Studio

Thank you for the solution you posted.

Gotta love JRE backwards compatibility.
Enthusiast

Re: Teradata Studio

Is there a way to specify the Port Number when setting up the Connection Details?
Teradata Employee

Re: Teradata Studio

Yes, edit the connection profile's JDBC Properties to include DBS_PORT. The default port number for Teradata is 1025, but you can change it for the connection by setting this property. Right click on the connection profile and select the Propertes, then Teradata JDBC Connection Properties. Click Add, then select DBS_PORT from the drop down list of JDBC Properties. In the Property Value, Click to enter a port value. Click OK to enter the value and OK to set the property.