Metadata-Version: 2.1
Name: c8-source-oracle
Version: 0.0.6
Summary: Pipelinewise tap for reading from oracle databases. This includes support for PDBs.
Home-page: https://www.macrometa.com/
License: Apache-2.0
Keywords: ELT,Connectors,Workflows,Macrometa,Oracle,Tap
Author: Macrometa
Author-email: info@macrometa.com
Requires-Python: >=3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: c8connector (>=0,<1)
Requires-Dist: cx-oracle (>=8.3.0,<9.0.0)
Requires-Dist: pipelinewise-singer-python (==1.2.0)
Requires-Dist: strict-rfc3339 (>=0.7,<0.8)
Project-URL: Bug Tracker, https://github.com/Macrometacorp/c8-source-oracle/issues
Description-Content-Type: text/markdown

# c8-source-oracle

[![License: MIT](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/licenses/GPL-3.0)

[Singer](https://www.singer.io/) tap that extracts data from a [Oracle](https://www.oracle.com/database/) database and produces JSON-formatted data following the [Singer spec](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md).

## How to use it

### Install and Run

First, make sure Python 3 is installed on your system or follow these
installation instructions for [Mac](http://docs.python-guide.org/en/latest/starting/install3/osx/) or
[Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-ubuntu-16-04).


It's recommended to use a virtualenv:

```bash
  python3 -m venv venv
  pip install c8-source-oracle
```

or from source using,
1. Install poetry using https://python-poetry.org/docs/#installation
2. Run 
    ```bash
    poetry build
    pip install dist/c8_source_oracle-<version>*.whl
    ```

### Configuration

Running the the tap requires a `config.json` file. 

Example configuration:

```json
{
  "host": "dev.oracledb.io",
  "port": 1521,
  "user": "C##HELLO",
  "password": "password",
  "service_name": "ORCLCDB",
  "filter_schemas": "C##HELLO",
  "default_replication_method": "LOG_BASED",
  "pdb_name": "ORCLPDB1",
  "multitenant": true,
  "scn_window_size": 10
}
```

You can run a discover run using the previous `config.json` file to acquire all the tables definition
 
```
c8-source-oracle --config /tmp/config.json --discover >> /tmp/catalog.json
```

Then use the catalog.json to run a full export:

```
c8-source-oracle --config /tmp/config.json --catalog /tmp/catalog.json
```


