Elastic Oracle connector reference
editElastic Oracle connector reference
editAvailability and prerequisites
editThis 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
editTo use this connector as a connector client, use the build a connector workflow. See Connector clients and frameworks.
The database user requires CONNECT
and DBA
privileges and must be the owner of the tables to be indexed.
Secure connection
editTo set up a secure connection the Oracle service must be installed on the system where the connector is running.
Follow these steps:
-
Set the
oracle_home
parameter to your Oracle home directory. If configuration files are not at the default location, set thewallet_configuration_path
parameter. -
Create a directory to store the wallet.
$ mkdir $ORACLE_HOME/ssl_wallet
-
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
-
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 Usage.
Compatibility
editOracle Database versions 18c, 19c and 21c are compatible with Elastic connector frameworks.
Configuration
editWhen using the build a connector 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 useTCPS
. -
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, useTCPS
. -
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.
Documents and syncs
edit- Files bigger than 10 MB won’t be extracted.
- Tables with no primary key defined are skipped.
-
If the table’s system change number (SCN) value is not between the
min(SCN)
andmax(SCN)
values of theSMON_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 thesys
user, use eithersysdba
orsysoper
and configure this as the username.
Sync rules
edit- Permissions are not synced.
- Filtering rules are not available in the current version, because filtering is controlled by ingest pipelines.
Connector client operations
editEnd-to-end testing
editThe 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
editThere are no known issues for this connector.
See Known issues for any issues affecting all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Framework and source
editThis connector is included in the Python connectors framework.
This connector uses the generic database connector source code (branch 8.7, compatible with Elastic 8.7).
View additional code specific to this data source (branch 8.7, compatible with Elastic 8.7).