Oracle Source Plugin

Latest: v4.2.0

The CloudQuery Oracle plugin extracts Oracle Cloud Infrastructure data (oci) and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more). It is based on the OCI Go SDK (opens in a new tab) and the Oracle Cloud REST API (opens in a new tab).

Authentication

In order for CloudQuery to sync resources from your Oracle Cloud setup, you will need to authenticate with your Oracle Cloud account. CloudQuery supports the same authentication methods as the OCI Go SDK, and uses the "default" configuration provider. You can read about how to create an Oracle Cloud configuration file in https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm (opens in a new tab).

Option 1: Config file

An example configuration file (e.g. in ~/.oci/config) looks like this:

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

Note that CloudQuery will sync information from all regions - not only the region specified in the oci config.

Option 2: Environment variables

Environment variables are configured the same way as for the terraform provider, and should therefore be prefixed with TF_VAR_ (e.g. TF_VAR_tenancy_ocid). See the documentation (opens in a new tab) for a full list of available variables.

Example environment variables:

export TF_VAR_security_token_file=/path/to/token/file
export TF_VAR_fingerprint="<your_fingerprint>"
export TF_VAR_tenancy_ocid="ocid1.tenancy.oc1..<unique_ID>"
export TF_VAR_user_ocid="ocid1.user.oc1..<unique_ID>"
export TF_VAR_region="us-ashburn-1"
export TF_VAR_private_key_path="~/.oci/oci_api_key.pem"

Configuration

In order to get started with the Oracle plugin, you need to create a YAML file in your CloudQuery configuration directory (e.g. named oracle.yml).

The following example sets up the Oracle plugin, and connects it to a postgresql destination:

kind: source
spec:
  name: "oracle"
  path: cloudquery/oracle
  version: "v4.2.0"
  destinations: ["postgresql"]
  tables: ["oracle_compute_instances"]
  spec:
    # Optional parameters
    # concurrency: 10000

See tables for a full list of available tables.

Oracle Spec

This is the (nested) spec used by Oracle Source Plugin

concurrency (int, optional, default: 10000): The best effort maximum number of Go routines to use. Lower this number to reduce memory usage.

Tables Tables