Database Connection #

Example Configuration #

kind: source
spec:
  name: oracledb
  path: cloudquery/oracledb
  registry: cloudquery
  version: "v4.7.4"
  tables: ["*"]
  destinations: ["postgresql"]
  # Learn more about the configuration options at https://cql.ink/oracledb_source
  spec:
    # A URL-encoded connection string used when connecting to the database in the format oracle://user:password@server:port/service_name.
    # If choosing this method, make sure that special characters like `#`, `%`, `"`, etc., are correctly URL encoded.
    #
    # It’s generally recommended to use the `dsn` connection method instead of `connection_string`, as it
    # helps avoid encoding errors by managing components separately.
    #
    # Note: To use the default port (1521), omit the port number from the connection string, but keep the
    # colon (:), for example: oracle://user:password@server:/service_name.
    # For more details, refer to the [Go driver documentation](https://github.com/sijms/go-ora).
    connection_string: "${ORACLE_DB_CONNECTION_STRING}"

    # Optional parameters
    # dsn:
    #   server: 127.0.0.1
    #   port: 1521
    #   user: system
    #   password: ${ORACLE_DB_PASSWORD}
    #   service: xe
    #   options:
    #     trace file: oracle-trace.txt
    # session_parameters:
    #   <SESSION_KEY>: "<VALUE>"
    # queries: []
    # rows_per_record: 500
    # concurrency: 100

Configuration Reference #

• connection_string (string) (required if dsn is not set)

  A URL-encoded connection string in the format oracle://{user}:{password}@{server}:{port}/{service_name}. If the connection string contains special characters, those symbols must be encoded. It's generally recommended to use the dsn instead of connection_string, as it helps to avoid encoding errors by managing components separately.

  Note: To use the default port (1521), omit the port number from the connection string, but keep the colon (:), for example: oracle://user@server:/service_name. For more details, refer to the Go driver documentation.
• dsn (DSN) (required if connection_string is not set)

  A set of components that are used to build a connection string. Using this connection method is preferred as it handles encoding for each part of the connection string, avoiding possible URL encoding errors.
• queries (list of queries Spec) (optional)

  (Preview feature) List of queries to run instead of directly reading tables. The tables in top-level spec should be left as * or can be a subset of these tables.
• rows_per_record (integer) (optional) (default: 500)

  Amount of rows to be packed into a single Apache Arrow record to be sent over the wire during sync.
• concurrency (integer) (optional) (default: 100)

  Number of tables to sync concurrently. Lower or increase this number based on your database size and available resources.
• session_parameters (map[string]string) (optional)

  A map of key-value pairs representing additional session parameters to be set after connecting to the database. These parameters are set using the ALTER SESSION command.

DSN Spec

• server (string) (required)

  A host used when building a connection string.
• port (int) (optional, default: 1521)

  A port used when building a connection string.
• service (string) (optional)

  A service name used when building a connection string.

  This value typically corresponds to the database edition, such as xe (for express), enterprise, standard, etc.
• user (string) (required)

  A username used in the authentication part of the connection string.
• password (string) (optional)

  A password used in the authentication part of the connection string.
• options (map[string]string) (optional)

  A map of key-value pairs representing additional connection options to include in the connection string.

Queries Spec (Preview) #

• name (string) (required)

  Name of the table to be generated from the query.
• query (string) (required)

  SQL query to run.

Example

kind: source
spec:
  name: oracledb
  path: cloudquery/oracledb
  registry: cloudquery
  version: "v4.7.4"
  tables: ["*"] # We want all tables specified in queries to be synced
  destinations: ["postgresql"]
  spec:
    # Connection string to connect to the database in the format oracle://user:password@server:port/service_name.
    # To use the default 1521 port, you can omit it from the connection string, but still need to keep the :, for example oracle://user:password@server:/service_name.
    connection_string: "${ORACLE_DB_CONNECTION_STRING}"
    queries:
      - name: all_oracle_tables
        query: SELECT * FROM ALL_TABLES