JBoss.orgCommunity Documentation

Teiid - Scalable Information Integration

Teiid Developer's Guide

7.6

Legal Notice

Abstract

This guide contains information for developers creating custom solutions with Teiid. It covers creating JEE JCA connectors with the Teiid framework, Teiid Translators, Teiid User Defined Functions (UDFs) as well as related topics.


1. Developing For Teiid
1.1. Introduction to the Teiid Connector Architecture
1.2. Do You Need a New Translator?
1.2.1. Custom Translators
1.3. Do You Need a New Resource Adapter?
1.3.1. Custom Resource Adapters
1.4. Other Teiid Development
2. Developing JEE Connectors
2.1. Using the Teiid Framework
2.1.1. Define Managed Connection Factory
2.1.2. Define the Connection Factory class
2.1.3. Define the Connection class
2.1.4. XA Transactions
2.1.5. Define the configuration properties in a "ra.xml" file
2.2. Build and Package the Adapter
2.3. Adding Dependent Libraries
2.4. Deploying the Adapter
3. Translator Development
3.1. Setting up the build environment
3.2. Extending the ExecutionFactory Class
3.2.1. ConnectionFactory
3.2.2. Connection
3.2.3. Configuration Properties
3.2.4. Initializing the Translator
3.2.5. TranslatorCapabilities
3.2.6. Execution (and sub-interfaces)
3.2.7. Metadata
3.2.8. Logging
3.2.9. Exceptions
3.3. Connections to Source
3.3.1. Obtaining connections
3.3.2. Releasing Connections
3.4. Executing Commands
3.4.1. Execution Modes
3.4.2. ExecutionContext
3.4.3. ResultSetExecution
3.4.4. Update Execution
3.4.5. Procedure Execution
3.4.6. Asynchronous Executions
3.4.7. Reusable Executions
3.4.8. Bulk Execution
3.4.9. Command Completion
3.4.10. Command Cancellation
3.5. Command Language
3.5.1. Language
3.5.2. Language Utilities
3.5.3. Runtime Metadata
3.5.4. Language Visitors
3.5.5. Translator Capabilities
3.6. Large Objects
3.6.1. Data Types
3.6.2. Why Use Large Object Support?
3.6.3. Handling Large Objects
3.6.4. Inserting or Updating Large Objects
3.7. Delegating Translator
3.8. Adding Dependent Libraries
3.9. Packaging
3.10. Deployment
4. Extending The JDBC Translator
4.1. Capabilities Extension
4.2. SQL Translation Extension
4.3. Results Translation Extension
4.4. Adding Function Support
4.4.1. Using FunctionModifiers
4.5. Installing Extensions
5. User Defined Functions
5.1. UDF Definition
5.2. Source Supported UDF
5.2.1. Designer based Source Function Pushdown
5.3. Non-pushdown Support for User-Defined Functions
5.3.1. Java Code
5.3.2. Post Code Activities
5.4. Installing user-defined functions
5.5. User Defined Functions in Dynamic VDBs
6. AdminAPI
6.1. Connecting
6.2. Admin Methods
7. Logging
7.1. Customized Logging
7.1.1. Command Logging API
7.1.2. Audit Logging API
8. Custom Security
8.1. Login Modules
8.1.1. Built-in LoginModules
8.1.2. Custom LoginModules
8.2. Custom Authorization
9. Runtime Updates
9.1. Data Updates
9.2. Runtime Metadata Updates
9.2.1. Costing Updates
9.2.2. Schema Updates
A. ra.xml file Template
B. Advanced Topics
B.1. Security Migration From Previous Versions