The metadata-extractor tool supports the following connection types.
These describe the details required when setting up on-premises database access.
PostgreSQL with basic authentication
Use <<: *psql
under the environment
section to use this connection type.
Available attributes:
HOST
- database host name or IP address (required)PORT
- database port (optional, default is 5432)DATABASE
- database name (required)USERNAME
- database user name (required)PASSWORD
- database user password (required)
Example
services:
my-psql-database:
<<: *extract
environment:
<<: *psql
USERNAME: db-user
PASSWORD: db-user-password
HOST: psql-database-host.internal
DATABASE: inventory
volumes:
- *shared-jdbc-drivers
- ./output/my-psql-database:/output
PostgreSQL with IAM authentication
Use <<: *psql-iam
under the environment
section to use this connection type.
Available attributes:
HOST
- database host name or IP address (required)PORT
- database port (optional, default is 5432)DATABASE
- database name (required)USERNAME
- database user name (required)AWS_ACCESS_KEY_ID
- AWS access key id (required)AWS_SECRET_ACCESS_KEY
- AWS secret access key (required)
Example
services:
my-psql-database:
<<: *extract
environment:
<<: *psql-iam
AWS_ACCESS_KEY_ID: my-access-key-id
AWS_SECRET_ACCESS_KEY: my-secret-access-key
USERNAME: db-user
HOST: psql-database-host.internal
DATABASE: inventory
volumes:
- *shared-jdbc-drivers
- ./output/my-psql-database:/output
MySQL with basic authentication
Use <<: *mysql
under the environment
section to use this connection type.
Available attributes:
HOST
- database host name or IP address (required)PORT
- database port (optional, default is 3306)USERNAME
- database user name (required)PASSWORD
- database user password (required)
Example
services:
my-mysql-database:
<<: *extract
environment:
<<: *mysql
USERNAME: db-user
PASSWORD: db-user-password
HOST: mysql-database-host.internal
volumes:
- *shared-jdbc-drivers
- ./output/my-mysql-database:/output
MySQL with IAM authentication
Use <<: *mysql-iam
under the environment
section to use this connection type.
Available attributes:
HOST
- database host name or IP address (required)PORT
- database port (optional, default is 3306)USERNAME
- database user name (required)AWS_ACCESS_KEY_ID
- AWS access key id (required)AWS_SECRET_ACCESS_KEY
- AWS secret access key (required)
Example
services:
my-mysql-database:
<<: *extract
environment:
<<: *mysql-iam
AWS_ACCESS_KEY_ID: my-access-key-id
AWS_SECRET_ACCESS_KEY: my-secret-access-key
USERNAME: db-user
HOST: mysql-database-host.internal
volumes:
- *shared-jdbc-drivers
- ./output/my-mysql-database:/output