Teradata Extractor

Keboola Connection Extractor for Teradata

Configuration

Options

The configuration requires a db node with the following properties:

• host - string (required): IP address or Hostname of Teradata server
• port - integer (optional): Database port (default port is 1025)
• user - string (required): User with correct access rights
• #password - string (required): Password for given User
• database - string (required): Database name

There are 2 possible types of table extraction.

1. A table defined by schema and tableName, this option can also include a columns list.
2. A query which is the SQL SELECT statement to be executed to produce the result table.

The extraction has the following configuration options:

• query: string (optional, but required if table not present)
• table: array (optional, but required if query not present)
  • schema: string
  • tableName: string
• columns: array of strings (only for table type configurations)
• outputTable: string (required)
• incremental: boolean (optional)
• primaryKey: array of strings (optional)

Example

Configuration with custom query:

{
    "parameters": {
        "db": {
            "host": "100.200.30.40",
            "user": "tduser",
            "#password": "tdpassword",
            "database": "tddatabase"
        },
        "name": "tablename",
        "query": "SELECT COUNT(*) c, column1 FROM tddatabase.tablename GROUP BY column1",
        "outputTable": "out.c-main.tablename",
        "incremental": false,
        "primaryKey": null
    }
}

Configuration with defined table:

{
	"parameters": {
		"db": {
		    "host": "100.200.30.40",
		    "user": "tduser",
		    "#password": "tdpassword",
		    "database": "tddatabase"
		},
		"name": "test_1",
		"outputTable": "out.c-main.test-1",
		"incremental": false,
		"primaryKey": null,
		"table": {
			"schema": "tddatabase",
			"tableName": "test_1"
		}
	}
}

Configuration with defined columns:

{
	"parameters": {
		"db": {
		    "host": "100.200.30.40",
		    "user": "tduser",
		    "#password": "tdpassword",
		    "database": "tddatabase"
		},
		"name": "test_1",
		"outputTable": "out.c-main.test-1",
		"incremental": false,
		"primaryKey": null,
		"table": {
			"schema": "tddatabase",
			"tableName": "test_1"
		},
		"columns": [
			"column1"
		]
	}
}

Development

Clone this repository and init the workspace with following command:

git clone https://github.com/keboola/ex-teradata
cd ex-teradata
docker-compose build
docker-compose run --rm dev composer install --no-scripts

Generate AWS credentials for drivers download:

docker run --rm -i \
--volume $HOME/.aws/:/root/.aws/ \
quay.io/keboola/aws-cli:latest sts get-session-token

Create .env file:

TERADATA_HOST=100.200.30.40
TERADATA_PORT=1025
TERADATA_USERNAME=user
TERADATA_PASSWORD=password
TERADATA_DATABASE=database_name

# Drivers download
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_SESSION_TOKEN=

Build the image:

docker-compose build dev

Tools

• Tests: docker-compose run --rm dev composer tests
  • Unit tests: docker-compose run --rm dev composer tests-phpunit
  • Datadir tests: docker-compose run --rm dev composer tests-datadir
• Code sniffer: docker-compose run --rm dev composer phpcs
• Static analysis: docker-compose run --rm dev composer phpstan

Integration

For information about deployment and integration with KBC, please refer to the deployment section of developers documentation

License

MIT licensed, see LICENSE file.