=================================================================
jaydebeapi-hsqldb
=================================================================
This project is based on `JayDeBeApi <https://github.com/baztian/jaydebeapi/>`_
and contains modifications to support
`sqlalchemy-hsqldb <https://github.com/Pebble94464/sqlalchemy-hsqldb.git>`_,
an SQLAlchemy dialect for HyperSQL 2.0.
Installation
------------
A package for installing jaydebeapi-hsqldb from `pypi.org <https://pypi.org/>`_
will soon be available
To install jaydebeapi-hsqldb from pypi.org, open a command prompt and type:
.. code-block:: sh
pip install jaydebeapi-hsqldb
Alternatively the module can be downloaded from its repository on GitHub:
`jaydebeapi-hsqldb repository <https://github.com/Pebble94464/jaydebeapi-hsqldb.git>`_
Use the 'pip install <path>' syntax to install, where <path> points to where
your local copy is installed, e.g.
.. code-block:: sh
pip install ./jaydebeapi-hsqldb
Post-install Configuration
--------------------------
Your system needs to know where the Java Runtime Environment is. If not
detected automatically you may need to add 'JAVA_HOME' or 'JRE_HOME' to your
environment variables.
.. code-block:: sh
set "JAVA_HOME=C:\Program Files\Java\jre-1.8\bin"
Getting Started
===============
The code example found in this section is provided as a quick hint on how to
connect to a HyperSQL server. You will need to update the parameters passed to
the connect method to reflect your system's configuration.
The 'jclassname' parameter, a.k.a. classpath, should be set to HyperSQL's
JDBCDriver class, i.e. 'org.hsqldb.jdbc.JDBCDriver'
The 'url' parameter will depend on your HyperSQL server's configuration.
This can be fairly complex, and rather explain it here I'll direct you to the
`JDBCConnection <http://hsqldb.org/doc/2.0/apidocs/org.hsqldb/org/hsqldb/jdbc/JDBCConnection.html>`_
documentation on hsqldb.org
The 'driver_args' parameter can be a sequence or dictionary, as described in
the documentation for the jaydebeapi.connect method.
The 'jars' parameter needs to include the location of your HSQLDB jar file,
.. code-block:: python
import jaydebeapi_hsqldb as jaydebeapi
jclassname = 'org.hsqldb.jdbc.JDBCDriver' # driver path
url = 'jdbc:hsqldb:hsql://localhost/db1' # connection string
driver_args = ['SA', ''] # username and password
jars = ('/PROGS/HSQLDB/hsqldb-osgi-jdk8.jar',) # location of HSQLDB jar
try:
conn = jaydebeapi.connect(
jclassname,
url,
driver_args,
jars
)
curs = conn.cursor()
curs.execute('VALUES(DATABASE_VERSION())')
version = curs.fetchone()[0]
print(f'\nSuccessfully connected!\nHSQLDB version: {version}\n')
curs.close()
conn.close()
except Exception as e:
# Connection failed...
print(f'\n{repr(e)}\n{str(e)}\n')
Troubleshooting
---------------
This project was coded and tested on a 64-bit Windows system. It should work on
other platforms too, but you may find the code examples and docs need adapting.
If you're struggling to get jaydebeapi-hsqldb working, here are a few things you can try:
* Avoid mixing 32-bit and 64-bit software components
* If the Java Runtime Environment (JRE) is not automatically detected you may need to add 'JAVA_HOME' or 'JRE_HOME' to your environment variables.
* If you suspect a permissions issue, try installing and running with an administrator account.
* If you suspect a firewall issue, temporarily disable the firewall to see if this is the case.
* If you suspect some other configuration issue, ensure all paths specified are correct. Use back slashes or forward slashes as appropriate for your OS. Do they need escaping?
* Submit a question via StackOverflow!
It's quite possible others have already encountered the same issue and SO can
often provide a quick response. Tag your question with an appropriate tag, such
as 'jaydebeapi-hsqldb', which I can then monitor.
If you think you've found a bug please feel welcome to submit a report via GitHub:
* `jaydebeapi-hsqldb issues <https://github.com/Pebble94464/jaydebeapi-hsqldb/issues>`_
Known Issues
============
- This release still contains debug code and is likely to halt when new datatypes are encountered.
Changelog
---------
0.0.1 initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/pebble94464/jaydebeapi-hsqldb",
"name": "jaydebeapi-hsqldb",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "hypersql hsqldb jdbc",
"author": "Pebble94464",
"author_email": "jaydebeapi-hsqldb@pebble.plus.com",
"download_url": "https://files.pythonhosted.org/packages/df/b9/7682bf14c8fb39a3d918c89a50829f4c1d3db6093a6ceb500d22e5242c62/jaydebeapi_hsqldb-0.0.2.tar.gz",
"platform": null,
"description": "=================================================================\r\njaydebeapi-hsqldb\r\n=================================================================\r\nThis project is based on `JayDeBeApi <https://github.com/baztian/jaydebeapi/>`_\r\nand contains modifications to support\r\n`sqlalchemy-hsqldb <https://github.com/Pebble94464/sqlalchemy-hsqldb.git>`_, \r\nan SQLAlchemy dialect for HyperSQL 2.0.\r\n\r\nInstallation\r\n------------\r\n\r\nA package for installing jaydebeapi-hsqldb from `pypi.org <https://pypi.org/>`_\r\nwill soon be available \r\nTo install jaydebeapi-hsqldb from pypi.org, open a command prompt and type:\r\n\r\n.. code-block:: sh\r\n\r\n\tpip install jaydebeapi-hsqldb\r\n\r\nAlternatively the module can be downloaded from its repository on GitHub:\r\n\r\n`jaydebeapi-hsqldb repository <https://github.com/Pebble94464/jaydebeapi-hsqldb.git>`_\r\n\r\nUse the 'pip install <path>' syntax to install, where <path> points to where\r\nyour local copy is installed, e.g.\r\n\r\n.. code-block:: sh\r\n\r\n\tpip install ./jaydebeapi-hsqldb\r\n\r\nPost-install Configuration\r\n--------------------------\r\nYour system needs to know where the Java Runtime Environment is. If not\r\ndetected automatically you may need to add 'JAVA_HOME' or 'JRE_HOME' to your\r\nenvironment variables.\r\n\r\n.. code-block:: sh\r\n\r\n\tset \"JAVA_HOME=C:\\Program Files\\Java\\jre-1.8\\bin\"\r\n\r\nGetting Started\r\n===============\r\nThe code example found in this section is provided as a quick hint on how to \r\nconnect to a HyperSQL server. You will need to update the parameters passed to \r\nthe connect method to reflect your system's configuration.\r\n\r\nThe 'jclassname' parameter, a.k.a. classpath, should be set to HyperSQL's\r\nJDBCDriver class, i.e. 'org.hsqldb.jdbc.JDBCDriver'\r\n\r\nThe 'url' parameter will depend on your HyperSQL server's configuration.\r\nThis can be fairly complex, and rather explain it here I'll direct you to the\r\n`JDBCConnection <http://hsqldb.org/doc/2.0/apidocs/org.hsqldb/org/hsqldb/jdbc/JDBCConnection.html>`_\r\ndocumentation on hsqldb.org\r\n\r\nThe 'driver_args' parameter can be a sequence or dictionary, as described in\r\nthe documentation for the jaydebeapi.connect method.\r\n\r\nThe 'jars' parameter needs to include the location of your HSQLDB jar file,\r\n\r\n.. code-block:: python\r\n\r\n\timport jaydebeapi_hsqldb as jaydebeapi\r\n\r\n\tjclassname = 'org.hsqldb.jdbc.JDBCDriver'\t\t# driver path\r\n\turl = 'jdbc:hsqldb:hsql://localhost/db1'\t\t# connection string\r\n\tdriver_args = ['SA', '']\t\t\t\t\t\t# username and password\r\n\tjars = ('/PROGS/HSQLDB/hsqldb-osgi-jdk8.jar',)\t# location of HSQLDB jar\r\n\r\n\ttry:\r\n\t\tconn = jaydebeapi.connect(\r\n\t\t\tjclassname,\r\n\t\t\turl,\r\n\t\t\tdriver_args,\r\n\t\t\tjars\r\n\t\t)\r\n\t\tcurs = conn.cursor()\r\n\t\tcurs.execute('VALUES(DATABASE_VERSION())')\r\n\t\tversion = curs.fetchone()[0]\r\n\t\tprint(f'\\nSuccessfully connected!\\nHSQLDB version: {version}\\n')\r\n\t\tcurs.close()\r\n\t\tconn.close()\r\n\texcept Exception as e:\r\n\t\t# Connection failed...\r\n\t\tprint(f'\\n{repr(e)}\\n{str(e)}\\n')\r\n\r\nTroubleshooting\r\n---------------\r\n\r\nThis project was coded and tested on a 64-bit Windows system. It should work on \r\nother platforms too, but you may find the code examples and docs need adapting.\r\n\r\nIf you're struggling to get jaydebeapi-hsqldb working, here are a few things you can try:\r\n\r\n* Avoid mixing 32-bit and 64-bit software components\r\n* If the Java Runtime Environment (JRE) is not automatically detected you may need to add 'JAVA_HOME' or 'JRE_HOME' to your environment variables.\r\n* If you suspect a permissions issue, try installing and running with an administrator account.\r\n* If you suspect a firewall issue, temporarily disable the firewall to see if this is the case.\r\n* If you suspect some other configuration issue, ensure all paths specified are correct. Use back slashes or forward slashes as appropriate for your OS. Do they need escaping?\r\n\r\n* Submit a question via StackOverflow!\r\n\tIt's quite possible others have already encountered the same issue and SO can\r\n\toften provide a quick response. Tag your question with an appropriate tag, such\r\n\tas 'jaydebeapi-hsqldb', which I can then monitor.\r\n\r\nIf you think you've found a bug please feel welcome to submit a report via GitHub:\r\n\r\n* `jaydebeapi-hsqldb issues <https://github.com/Pebble94464/jaydebeapi-hsqldb/issues>`_\r\n\r\nKnown Issues\r\n============\r\n- This release still contains debug code and is likely to halt when new datatypes are encountered.\r\n\r\nChangelog\r\n---------\r\n\t0.0.1\tinitial release\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A module for connecting to HyperSQL using JDBC, based on JayDeBeApi",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/pebble94464/jaydebeapi-hsqldb"
},
"split_keywords": [
"hypersql",
"hsqldb",
"jdbc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "faf255296ec2583d1ba3b787a9488f7579705f3c6e6615b811a885266f4bb590",
"md5": "e54a7b0591ecf03fd676721be7e9ef17",
"sha256": "67fc7516d4899e3de2d8a0f2a9d7f7089d89bdef45c69f294973f08e87d0e67c"
},
"downloads": -1,
"filename": "jaydebeapi_hsqldb-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e54a7b0591ecf03fd676721be7e9ef17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 26804,
"upload_time": "2024-12-03T22:58:33",
"upload_time_iso_8601": "2024-12-03T22:58:33.209834Z",
"url": "https://files.pythonhosted.org/packages/fa/f2/55296ec2583d1ba3b787a9488f7579705f3c6e6615b811a885266f4bb590/jaydebeapi_hsqldb-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dfb97682bf14c8fb39a3d918c89a50829f4c1d3db6093a6ceb500d22e5242c62",
"md5": "3af323ba5359fab549d3e0245702d89b",
"sha256": "9db429f4a4f73c29ff229c8711b3957716ed1d591af5e5d4df0ecee3a5656272"
},
"downloads": -1,
"filename": "jaydebeapi_hsqldb-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3af323ba5359fab549d3e0245702d89b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32660,
"upload_time": "2024-12-03T22:58:35",
"upload_time_iso_8601": "2024-12-03T22:58:35.338061Z",
"url": "https://files.pythonhosted.org/packages/df/b9/7682bf14c8fb39a3d918c89a50829f4c1d3db6093a6ceb500d22e5242c62/jaydebeapi_hsqldb-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 22:58:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pebble94464",
"github_project": "jaydebeapi-hsqldb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "jaydebeapi-hsqldb"
}
JSON
