Back to source list
Official
Premium
OracleDB
The CloudQuery OracleDB plugin syncs your OracleDB database to any of the supported CloudQuery destinations
Publisher
cloudquery
Latest version
v4.7.3
Type
Source
Platforms
Date Published
Price per 1M rows
Starting from $17
monthly free quota
1M rows
Set up process #
brew install cloudquery/tap/cloudquery
1. Download CLI and login
2. Create source and destination configs
Plugin configurationOverview #
The CloudQuery OracleDB plugin syncs your OracleDB database to any of the supported CloudQuery destinations (e.g. PostgreSQL, BigQuery, Snowflake, and more).
Database Connection #
In order for CloudQuery to sync resources from your Oracle Database, you will need to use one of the supported connection methods.
More details on each method are provided in the configuration reference section.
Example Configuration #
kind: source
spec:
name: oracledb
path: cloudquery/oracledb
registry: cloudquery
version: "v4.7.3"
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 #
This is the (nested) spec used by the OracleDB destination plugin.
connection_string
(string
) (required ifdsn
is not set)A URL-encoded connection string in the formatoracle://{user}:{password}@{server}:{port}/{service_name}
. If the connection string contains special characters, those symbols must be encoded. It's generally recommended to use thedsn
instead ofconnection_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. - 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. Thetables
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 theALTER 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 asxe
(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) #
Allows running arbitrary queries instead of fetching existing tables. Each query will be run as a separate table.
name
(string
) (required)Name of the table to be generated from the query.query
(string
) (required)SQL query to run.
Example
The below config duplicates the
ALL_TABLES
meta table to the destination, as all_oracle_tables
table:kind: source
spec:
name: oracledb
path: cloudquery/oracledb
registry: cloudquery
version: "v4.7.3"
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
Licenses #
The following tools / packages are used in this plugin:
Name | License |
---|---|
github.com/adrg/xdg | MIT |
github.com/apache/arrow/go/v13 | Apache-2.0 |
github.com/apache/arrow/go/v17 | Apache-2.0 |
github.com/apapsch/go-jsonmerge/v2 | MIT |
github.com/aws/aws-sdk-go-v2 | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/config | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/credentials | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/feature/ec2/imds | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/internal/configsources | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/internal/ini | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/internal/sync/singleflight | BSD-3-Clause |
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/service/licensemanager | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/service/marketplacemetering | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/service/sso | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/service/ssooidc | Apache-2.0 |
github.com/aws/aws-sdk-go-v2/service/sts | Apache-2.0 |
github.com/aws/smithy-go | Apache-2.0 |
github.com/aws/smithy-go/internal/sync/singleflight | BSD-3-Clause |
github.com/cenkalti/backoff/v4 | MIT |
github.com/cloudquery/cloudquery-api-go | MPL-2.0 |
github.com/cloudquery/plugin-pb-go | MPL-2.0 |
github.com/cloudquery/plugin-sdk/v2/internal/glob | MIT |
github.com/cloudquery/plugin-sdk/v2/schema | MIT |
github.com/cloudquery/plugin-sdk/v2/types | MPL-2.0 |
github.com/cloudquery/plugin-sdk/v4 | MPL-2.0 |
github.com/cloudquery/plugin-sdk/v4/glob | MIT |
github.com/cloudquery/plugin-sdk/v4/scalar | MIT |
github.com/davecgh/go-spew/spew | ISC |
github.com/ghodss/yaml | MIT |
github.com/go-logr/logr | Apache-2.0 |
github.com/go-logr/stdr | Apache-2.0 |
github.com/goccy/go-json | MIT |
github.com/google/flatbuffers/go | Apache-2.0 |
github.com/google/uuid | BSD-3-Clause |
github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors | Apache-2.0 |
github.com/grpc-ecosystem/grpc-gateway/v2 | BSD-3-Clause |
github.com/hashicorp/go-cleanhttp | MPL-2.0 |
github.com/hashicorp/go-retryablehttp | MPL-2.0 |
github.com/klauspost/compress | Apache-2.0 |
github.com/klauspost/compress/internal/snapref | BSD-3-Clause |
github.com/klauspost/compress/zstd/internal/xxhash | MIT |
github.com/mattn/go-colorable | MIT |
github.com/mattn/go-isatty | MIT |
github.com/oapi-codegen/runtime | Apache-2.0 |
github.com/pierrec/lz4/v4 | BSD-3-Clause |
github.com/pmezard/go-difflib/difflib | BSD-3-Clause |
github.com/rs/zerolog | MIT |
github.com/santhosh-tekuri/jsonschema/v6 | Apache-2.0 |
github.com/sijms/go-ora/v2 | MIT |
github.com/spf13/cobra | Apache-2.0 |
github.com/spf13/pflag | BSD-3-Clause |
github.com/stretchr/testify | MIT |
github.com/thoas/go-funk | MIT |
github.com/zeebo/xxh3 | BSD-2-Clause |
go.opentelemetry.io/otel | Apache-2.0 |
go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp | Apache-2.0 |
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp | Apache-2.0 |
go.opentelemetry.io/otel/exporters/otlp/otlptrace | Apache-2.0 |
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp | Apache-2.0 |
go.opentelemetry.io/otel/log | Apache-2.0 |
go.opentelemetry.io/otel/metric | Apache-2.0 |
go.opentelemetry.io/otel/sdk | Apache-2.0 |
go.opentelemetry.io/otel/sdk/log | Apache-2.0 |
go.opentelemetry.io/otel/sdk/metric | Apache-2.0 |
go.opentelemetry.io/otel/trace | Apache-2.0 |
go.opentelemetry.io/proto/otlp | Apache-2.0 |
golang.org/x/exp | BSD-3-Clause |
golang.org/x/net | BSD-3-Clause |
golang.org/x/sync/errgroup | BSD-3-Clause |
golang.org/x/sys | BSD-3-Clause |
golang.org/x/text | BSD-3-Clause |
golang.org/x/xerrors | BSD-3-Clause |
google.golang.org/genproto/googleapis/api/httpbody | Apache-2.0 |
google.golang.org/genproto/googleapis/rpc/status | Apache-2.0 |
google.golang.org/grpc | Apache-2.0 |
google.golang.org/protobuf | BSD-3-Clause |
gopkg.in/yaml.v2 | Apache-2.0 |
gopkg.in/yaml.v3 | MIT |