Skip to main content
The Ocient Python module pyocient supports direct connections to Ocient systems in a command-line interface (CLI) as well as in Python programs that follow the Python Database API Specification 2.0. After you install pyocient, you can establish Ocient connections to run queries and commands.

​
Installation Tutorial

To install and run pyocient, follow these steps.

​
Install pyocient

Install pyocient using pip: 
pip3 install pyocient
After running the pip install, pyocient is installed in the bin directory. Use venv to install pyocient using a virtual environment. For more information, see the Python venv documentation.

​
Start pyocient

pyocient is started from the command line with a connection string. It includes many options to configure the connection and client similar to the JDBC driver. Learn more about supported options in the pyocient Manual. After installation, you can launch from a command line by typing the pyocient command: 
pyocient ocient://example_user:example_password@10.10.1.1/system
To connect to the system database, replace the example username (example_user) and password (example_password) with your credentials, and set your IP address. The connection example assumes a SQL Node exists at 10.10.1.1. The example uses the default port 4050, and is set up with default self-signed certificates for TLS. Example Response: 
Ocient Database™ System version <<Ocient System version>>, client version <<pyocient version>>
>>
Use the command quit; to exit the pyocient CLI interface.

​
Run a Query

In the pyocient CLI, you can run any SQL query supported by your database. In this example, a query is selecting rows from the system tables: 
select * from sys.tables;
You can also run queries from the command line with the connection string: 
pyocient ocient://example_user:example_password@10.10.1.1/system 'select * from sys.tables'
Example Response: 
[
  {
    "id": "359e21b1-770a-4860-aec9-f158d307f725",
    "name": "data_type_coverage",
    "schema": "loading",
    "database_id": "f827ff7c-dd94-43bf-8386-93d048344a32",
    "storage_space_id": "2ad08e7c-15d1-4861-b38b-256c4df4a191",
    "maximum_segment_size_gib": 4,
    "description": null,
    "streamloader_property_string": null,
    "created_at": "2023-08-08t21:22:49.622213"
  }
]
The system cancels any queries made with the pyocient driver if you perform any of these actions:
  • Fetch the entire result set.
  • Close the connection.
  • Execute a new query using the same connection.
For more information and API reference material for pyocient, see the pyocient Manual page.