IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic network drive connector reference Elastic PostgreSQL connector reference »
Elastic Docs › ›Elastic connectors

Elastic Oracle connector reference

edit

Elastic Oracle connector reference

edit

Availability and prerequisites

edit

This connector is available as a connector client from the Python connectors framework. This connector client is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usage

edit

To use this connector as a connector client, see Connector clients.

The database user requires CONNECT and DBA privileges and must be the owner of the tables to be indexed.

Secure connection

edit

To set up a secure connection the Oracle service must be installed on the system where the connector is running.

Follow these steps:

  1. Set the oracle_home parameter to your Oracle home directory. If configuration files are not at the default location, set the wallet_configuration_path parameter.

  2. Create a directory to store the wallet.

    $ mkdir $ORACLE_HOME/ssl_wallet

  3. Create file named sqlnet.ora at $ORACLE_HOME/network/admin and add the following content:

    WALLET_LOCATION = (SOURCE = (METHOD = FILE) (METHOD_DATA = (DIRECTORY = $ORACLE_HOME/ssl_wallet)))
SSL_CLIENT_AUTHENTICATION = FALSE
SSL_VERSION = 1.0
SSL_CIPHER_SUITES = (SSL_RSA_WITH_AES_256_CBC_SHA)
SSL_SERVER_DN_MATCH = ON

  4. Run the following commands to create a wallet and attach an SSL certificate. Replace the file name with your file name.

    $ orapki wallet create -wallet path-to-oracle-home/ssl_wallet -auto_login_only
$ orapki wallet add -wallet path-to-oracle-home/ssl_wallet -trusted_cert -cert path-to-oracle-home/ssl_wallet/root_ca.pem -auto_login_only

For more information, refer to this Amazon RDS documentation about Oracle SSL. Oracle docs: https://docs.oracle.com/database/121/DBSEG/asossl.htm#DBSEG070.

For additional operations, see Using connectors.

Compatibility

edit

Oracle Database versions 18c, 19c and 21c are compatible with Elastic connector frameworks.

Configuration

edit

When using the connector client workflow, these fields will use the default configuration set in the connector source code. Note that this data source uses the generic_database.py connector source code. Refer to oracle.py for additional code, specific to this data source.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, users will be able to update these values in Kibana.

The following configuration fields are required to set up the connector:

host
The IP address or hostname of the Oracle database server. Default value is 127.0.0.1.
port

Port number of the Oracle database server. Default value is 1521.

  • oracle_protocol

    The protocol which the connector uses to establish a connection. Default value is TCP. For secured connections, a user needs to use TCPS.

  • oracle_home

    Path of the Oracle home directory to run connector with thick mode for secured connection. By default connector will run on Thin Mode. For unsecured connections, keep this field empty.

  • wallet_configuration_path

    Path of the oracle configuration files. Only applicable when configuration files are not at the default location. By default files are located at $ORACLE_HOME/network/admin. Keep this field empty unless files are not at default location.

username
Username to use to connect to the Oracle database server.
password
Password to use to connect to the Oracle database server.
database
SID of the Oracle database to connect to.
tables

Comma-separated list of tables to monitor for changes. Default value is *. Examples:

  • TABLE_1, TABLE_2
  • *
fetch_size
Number of rows to fetch per request. Default value is 50.
retry_count
Number of retry attempts after failed request to Oracle Database. Default value is 3.
oracle_protocol
Protocol which the connector uses to establish a connection. Default value is TCP. For secure connections, use TCPS.
oracle_home
Path of the Oracle home directory to run connector in thick mode for secured connection. For unsecured connections, keep this field empty.
wallet_configuration_path
Path of Oracle configuration files. Only applicable when configuration files are not at the default location. If files are located at the default location, keep this field empty.

Deployment using Docker

edit

You can deploy the Oracle connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-python-config/config.yml

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.password
  • connector_id
  • service_type

Use oracle as the service_type value. Don’t forget to uncomment "oracle" in the sources section of the yaml file.

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

elasticsearch:
  host: http://host.docker.internal:9200
  username: elastic
  password: <YOUR_PASSWORD>

connector_id: <CONNECTOR_ID_FROM_KIBANA>
service_type: oracle

sources:
  # UNCOMMENT "oracle" below to enable the Oracle connector

  #mongodb: connectors.sources.mongo:MongoDataSource
  #s3: connectors.sources.s3:S3DataSource
  #dir: connectors.sources.directory:DirectoryDataSource
  #mysql: connectors.sources.mysql:MySqlDataSource
  #network_drive: connectors.sources.network_drive:NASDataSource
  #google_cloud_storage: connectors.sources.google_cloud_storage:GoogleCloudStorageDataSource
  #azure_blob_storage: connectors.sources.azure_blob_storage:AzureBlobStorageDataSource
  #postgresql: connectors.sources.postgresql:PostgreSQLDataSource
  #oracle: connectors.sources.oracle:OracleDataSource
  #mssql: connectors.sources.mssql:MSSQLDataSource

Note that the config file you downloaded might contain more entries, so you will need to manually copy/change the settings that apply to you. Normally you’ll only need to update elasticsearch.host, elasticsearch.password, connector_id and service_type to run the connector service.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

docker run \
-v ~/connectors-python-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.9.2.0-SNAPSHOT \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to this guide in the Python framework repository for more details.

Documents and syncs

edit
  • Tables with no primary key defined are skipped.
  • If the table’s system change number (SCN) value is not between the min(SCN) and max(SCN) values of the SMON_SCN_TIME table, the connector will not be able to retrieve the most recently updated time. Data will therefore index in every sync. For more details refer to the following discussion thread.
  • The sys user is not supported, as it contains 1000+ system tables. If you need to work with the sys user, use either sysdba or sysoper and configure this as the username.
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default.

Advanced sync rules are not available for this connector in the present version. Currently, filtering is controlled by ingest pipelines.

Content extraction

edit

See Content extraction.

Connector client operations

edit

End-to-end testing

edit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To execute a functional test for the Oracle connector, run the following command:

make ftest NAME=oracle

By default, this will use a medium-sized dataset. To make the test faster add the DATA_SIZE=small argument:

make ftest NAME=oracle DATA_SIZE=small

Known issues

edit

There are no known issues for this connector.

See Known issues for any issues affecting all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Framework and source

edit

This connector is included in the Python connectors framework.

This connector uses the generic database connector source code (branch 8.9, compatible with Elastic 8.9).

View additional code specific to this data source (branch 8.9, compatible with Elastic 8.9).

« Elastic network drive connector reference Elastic PostgreSQL connector reference »