Metadata-Version: 2.4
Name: actian-analytics-odbc
Version: 1.0.0
Summary: Actian Analytics ODBC
Author-email: Actian Corp <support@actian.com>
License-Expression: LicenseRef-Actian-Client-1.0
Keywords: odbc,ingres,vector,actian,analytics
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyodbc>=5.3.0
Dynamic: license-file

# Actian Analytics ODBC: Connect pyodbc applications to Actian Ingres/Vector/Analytics databases

## What is it?

**Actian Analytics ODBC** is a Python package that provides a fast installation of Actian Client for ODBC and easy connections between pyodbc applications and Actian databases such as  Ingres, Vector, and Actian Analytics Engine.

## Main Features
- Contains the Actian Client SDK, no need to download it separately
- Automates installation of Actian Analytics SDK package
- Provides a simple API that extends [pyodbc](https://pypi.org/project/pyodbc/) to provide a [Python Database API 2.0](https://peps.python.org/pep-0249/) standard database connection to Actian databases.

## Prerequisites

### OS

Linux-x64 is supported at this time.

### Python

Python 3.9 or higher is required to install and run.

### ODBC Manager

You need an ODBC manager before installing this package. The simplest option on Linux is to run.

```sh
$ sudo apt install unixodbc
```

If you do not have an ODBC manager installed, importing the actiandb package will fail with an error.

## Where to get it

The latest released version are available at the [Python
Package Index (PyPI)](https://pypi.org/project/actian-analytics-odbc).

```sh
# PyPI
pip install actian-analytics-odbc
```

## Dependencies
- [pyodbc - pyodbc is an open source Python module that makes accessing ODBC databases simple.](https://github.com/mkleehammer/pyodbc)

## Platform Support

Currently only Linux x64 environments are supported.

## License
[Commercial] See license inside of package

## Example Usage
```python
import actiandb
conn = actiandb.connect(
    database='databaseName',
    hostname='host-or-ip',
    port='port-or-service',
    username='username',
    password='password'
)
cur = conn.execute("SELECT * FROM region")
for row in cur:
  print(row)
conn.close()
```
