diff --git a/README.md b/README.md index a08000f..dcfba86 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,129 @@ -# InterBase Driver for Python, supporting 32-bit and 64-bit +# InterBase Driver for Python -[InterBase Documentation](https://docwiki.embarcadero.com/InterBase/2020/en/Main_Page) \* -[InterBase Source](https://github.com/Embarcadero/InterBasePython) \* -[Based On FDB](http://www.firebirdsql.org/en/devel-python-driver/) +InterBase -Changes implemented are based on this blog post +> A powerful, [PEP-249-compliant](https://peps.python.org/pep-0249/) Python driver for **InterBase**, supporting both 32-bit and 64-bit. -InterBase Driver for Python is a [Python](http://python.org) library package that implements -[Python Database API 2.0](http://www.python.org/dev/peps/pep-0249/)-compliant support for the Embarcadero SQL Database -[InterBase](https://interbase.com/) ยฎ. In addition to the minimal -feature set of the standard Python DB API, InterBase Driver for Python also exposes the entire -native (old-style) client API of the database engine. Notably: +The **InterBase Driver for Python** is based on the [FDB driver](http://www.firebirdsql.org/en/devel-python-driver/) and provides access to the [InterBase](https://interbase.com/) RDBMS using a robust and flexible Python interface. This package supports the **Python Database API 2.0** standard (PEP-249) while offering extended access to the native InterBase API. - - Automatic data conversion from strings on input. - - Automatic input/output conversions of textual data between UNICODE - and database character sets. - - Support for prepared SQL statements. - - Multiple independent transactions per single connection. - access specifications. - - Distributed transactions. +๐Ÿ“š [InterBase Documentation](https://docwiki.embarcadero.com/InterBase/2020/en/Main_Page) +๐Ÿ”— [GitHub Source Code](https://github.com/Embarcadero/InterBasePython) -Install (32-bit or 64-bit version of python 3.* required) +--- -You can use one of the following ways to do it. +## โœจ Features -`pip install interbase` +- PEP-249 compliance +- Full Unicode and character set support +- Native API access +- Multiple independent transactions per connection +- Distributed transaction support +- Automatic conversion of textual data +- Prepared statement support -`pip install git+https://github.com/Embarcadero/InterBasePython.git` +--- -`pip install git+ssh://git@github.com/Embarcadero/InterBasePython.git` +## ๐Ÿ“ฆ Installation -To create a test DB: +> Requires Python 3.x (32-bit or 64-bit version to match InterBase client). -`cd test/files && isql -i create-test-db.sql` +Install via PyPI: +```bash +pip install interbase +``` + +Or install from the GitHub repository: +```bash +pip install git+https://github.com/Embarcadero/InterBasePython.git +# or via SSH: +pip install git+ssh://git@github.com/Embarcadero/InterBasePython.git +``` + +--- + +## ๐Ÿงช Setting Up a Test Database + +```bash +cd test/files +isql -i create-test-db.sql +``` + +--- + +## ๐Ÿ”Œ Sample Usage + +### Basic Connection +```python +import interbase + +con = interbase.connect( + host=IBTEST_HOST, # Hostname or IP address of the InterBase server + database=IBTEST_DB_PATH, # Path to the database file on the server + user=IBTEST_USER, # Username for authentication + password=IBTEST_PASSWORD, # Password for authentication + sql_dialect=IBTEST_SQL_DIALECT, # SQL dialect to use (usually 1 or 3) + ssl=IBTEST_SERVER_PUBLIC_FILE is not None, # Enable SSL if a public server key is provided + server_public_file=IBTEST_SERVER_PUBLIC_FILE # Path to the server's public SSL key file (if SSL is enabled) +) +``` + +### Executing a Query +```python +cur = con.cursor() +cur.execute("SELECT * FROM employees") +for row in cur: + print(row) +``` + +### Using Parameters +```python +cur.execute("INSERT INTO employees(name, age) VALUES (?, ?)", ("John Doe", 34)) +con.commit() +``` + +### Handling Transactions + +#### Manual Transaction Control +```python +transaction = con.main_transaction +transaction.begin() + +cursor = transaction.cursor() +cursor.execute("INSERT INTO t (c1) VALUES (1)") +transaction.commit() +``` + +#### Using a Context Manager +```python +import interbase + +with interbase.TransactionContext(con) as tr: + cursor = tr.cursor() + cursor.execute("INSERT INTO t (c1) VALUES (1)") +# The transaction is automatically committed when the block ends. +``` + +--- + +## ๐Ÿงฐ More Examples +Explore the `test` folder in the [GitHub Repository](https://github.com/Embarcadero/InterBasePython) for full coverage of features, including: + +- Working with BLOBs +- Using metadata APIs +- Working with stored procedures +- SSL support +- Error handling + +--- + +## ๐Ÿค Contributing +Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. + +--- + +## ๐Ÿ“œ License +This project is licensed under the Embarcadero license terms. + +--- + +> ๐Ÿ”— Stay up to date with the latest changes and enhancements to InterBase by following the official [Embarcadero Blog](https://blogs.embarcadero.com/).