# trovares_connector Package
[](https://github.com/trovares/trovares_connector/actions/workflows/pytest.yml)
[](https://pypi.python.org/pypi/trovares_connector)
[](https://pypi.python.org/pypi/trovares_connector)
[](https://github.com/trovares/trovares_connector/blob/main/LICENSE)
[](https://twitter.com/TrovaresxGT)
This Python package is for connecting the Trovares xGT graph analytics engine to other applications.
Trovares xGT can [significantly speedup Neo4j queries](https://www.trovares.com/trovaresvneo4j).
The default connector provided is for Neo4j or AuraDB.
The package also provides an optional ODBC connector for connecting to databases or applications that support ODBC.
Information about the ODBC connector can be found [in the documentation](https://trovares.github.io/trovares_connector/odbc).
<table>
<tr>
<td><b>Homepage:</b></td>
<td><a href="https://www.trovares.com">trovares.com</a></td>
</tr>
<tr>
<td><b>Documentation:</b></td>
<td><a href="https://trovares.github.io/trovares_connector/">trovares.github.io/trovares_connector</a></td>
</tr>
<tr>
<td><b>General Help:</b></td>
<td><a href="https://github.com/trovares/trovares_connector/discussions">github.com/trovares/trovares_connector/discussions</a></td>
</tr>
</table>
## Requirements
- [Neo4j Python](https://pypi.org/project/neo4j/)
- [xGT Python](https://pypi.org/project/xgt/)
- [Pyarrow](https://pypi.org/project/pyarrow/)
- [Trovares xGT](https://www.trovares.com)
## Installation
You can install this python package by executing this command:
```bash
python -m pip install trovares_connector
```
If you want to use the ODBC connector, you can install the optional dependencies like so:
```bash
python -m pip install 'trovares_connector[odbc]'
```
If you don't have Trovares xGT, you can install and run the [Developer version](https://hub.docker.com/r/trovares/xgt) from Docker:
```bash
docker pull trovares/xgt
docker run --publish=4367:4367 trovares/xgt
```
## Using the trovares_connector
From any Python environment, simply importing both `xgt` and `trovares_connector` is all that is needed to operate this connector.
A simple example below shows connecting to Neo4j and xGT, transferring the whole graph database to xGT, running a query in xGT, and printing the results:
```python
import xgt
from trovares_connector import Neo4jConnector, Neo4jDriver
# Connect to xGT and Neo4j.
xgt_server = xgt.Connection()
xgt_server.set_default_namespace('neo4j')
neo4j_server = Neo4jDriver(auth=('neo4j', 'foo'))
conn = Neo4jConnector(xgt_server, neo4j_server)
# Transfer the whole graph.
conn.transfer_to_xgt()
# Run the query.
query = "match(a:foo) return a"
job = xgt_server.run_job(query)
# Print results.
print("Results: ")
for row in job.get_data():
print(row)
```
## API
The available properties are:
- neo4j_relationship_types
- neo4j_node_labels
- neo4j_property_keys
- neo4j_node_type_properties
- neo4j_rel_type_properties
- neo4j_nodes
- neo4j_edges
The available methods are:
- get_xgt_schemas
- create_xgt_schemas
- copy_data_to_xgt
- transfer_to_xgt
- transfer_to_neo4j
## Examples
Some examples can be found here:
- [Python examples](https://github.com/trovares/trovares_connector/tree/main/examples)
- [Jupyter notebooks](https://github.com/trovares/trovares_connector/tree/main/jupyter)
Raw data
{
"_id": null,
"home_page": "http://www.trovares.com/",
"name": "trovares-connector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Neo4j Trovares xGT cypher ODBC database",
"author": "Trovares, Inc.",
"author_email": "support@trovares.com",
"download_url": "https://files.pythonhosted.org/packages/b9/01/5e338fd23c741a329f5d8fa77bc14dfc75ff6f3cbb6bd06db523520b7a90/trovares_connector-2.5.0.tar.gz",
"platform": null,
"description": "# trovares_connector Package\n\n[](https://github.com/trovares/trovares_connector/actions/workflows/pytest.yml)\n[](https://pypi.python.org/pypi/trovares_connector)\n[](https://pypi.python.org/pypi/trovares_connector)\n[](https://github.com/trovares/trovares_connector/blob/main/LICENSE)\n[](https://twitter.com/TrovaresxGT)\n\nThis Python package is for connecting the Trovares xGT graph analytics engine to other applications.\nTrovares xGT can [significantly speedup Neo4j queries](https://www.trovares.com/trovaresvneo4j).\n\nThe default connector provided is for Neo4j or AuraDB.\nThe package also provides an optional ODBC connector for connecting to databases or applications that support ODBC.\nInformation about the ODBC connector can be found [in the documentation](https://trovares.github.io/trovares_connector/odbc). \n\n<table>\n <tr>\n <td><b>Homepage:</b></td>\n <td><a href=\"https://www.trovares.com\">trovares.com</a></td>\n </tr>\n <tr>\n <td><b>Documentation:</b></td>\n <td><a href=\"https://trovares.github.io/trovares_connector/\">trovares.github.io/trovares_connector</a></td>\n </tr>\n <tr>\n <td><b>General Help:</b></td>\n <td><a href=\"https://github.com/trovares/trovares_connector/discussions\">github.com/trovares/trovares_connector/discussions</a></td>\n </tr>\n</table>\n\n## Requirements\n\n - [Neo4j Python](https://pypi.org/project/neo4j/)\n - [xGT Python](https://pypi.org/project/xgt/)\n - [Pyarrow](https://pypi.org/project/pyarrow/)\n - [Trovares xGT](https://www.trovares.com)\n\n## Installation\n\nYou can install this python package by executing this command:\n\n```bash\npython -m pip install trovares_connector\n```\n\nIf you want to use the ODBC connector, you can install the optional dependencies like so:\n```bash\npython -m pip install 'trovares_connector[odbc]'\n```\n\nIf you don't have Trovares xGT, you can install and run the [Developer version](https://hub.docker.com/r/trovares/xgt) from Docker:\n\n```bash\ndocker pull trovares/xgt\ndocker run --publish=4367:4367 trovares/xgt\n```\n## Using the trovares_connector\n\nFrom any Python environment, simply importing both `xgt` and `trovares_connector` is all that is needed to operate this connector.\n\nA simple example below shows connecting to Neo4j and xGT, transferring the whole graph database to xGT, running a query in xGT, and printing the results:\n\n```python\nimport xgt\nfrom trovares_connector import Neo4jConnector, Neo4jDriver\n\n# Connect to xGT and Neo4j.\nxgt_server = xgt.Connection()\nxgt_server.set_default_namespace('neo4j')\nneo4j_server = Neo4jDriver(auth=('neo4j', 'foo'))\nconn = Neo4jConnector(xgt_server, neo4j_server)\n\n# Transfer the whole graph.\nconn.transfer_to_xgt()\n\n# Run the query.\nquery = \"match(a:foo) return a\"\njob = xgt_server.run_job(query)\n\n# Print results.\nprint(\"Results: \")\nfor row in job.get_data():\n print(row)\n```\n\n## API\n\nThe available properties are:\n\n - neo4j_relationship_types\n - neo4j_node_labels\n - neo4j_property_keys\n - neo4j_node_type_properties\n - neo4j_rel_type_properties\n - neo4j_nodes\n - neo4j_edges\n\nThe available methods are:\n\n - get_xgt_schemas\n - create_xgt_schemas\n - copy_data_to_xgt\n - transfer_to_xgt\n - transfer_to_neo4j\n\n## Examples\n\nSome examples can be found here:\n\n - [Python examples](https://github.com/trovares/trovares_connector/tree/main/examples)\n - [Jupyter notebooks](https://github.com/trovares/trovares_connector/tree/main/jupyter)\n",
"bugtrack_url": null,
"license": "apache2",
"summary": "Connecting the Trovares xGT graph analytics engine to other applications.",
"version": "2.5.0",
"project_urls": {
"Changelog": "https://github.com/trovares/trovares_connector/blob/main/RELEASE.rst",
"Documentation": "https://trovares.github.io/trovares_connector/",
"Homepage": "http://www.trovares.com/",
"Repository": "https://github.com/trovares/trovares_connector"
},
"split_keywords": [
"neo4j",
"trovares",
"xgt",
"cypher",
"odbc",
"database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52b5a00c30b443acb3dda52d7afcda06c251e5b9641debf42ac30f5c1f660ec5",
"md5": "8df13ecd41c5c9d9c7b032577c6909c1",
"sha256": "47b8ecd48994598410aeed9b2ce7aa44839c275b0ad9ecd36f5e4916fc35d547"
},
"downloads": -1,
"filename": "trovares_connector-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8df13ecd41c5c9d9c7b032577c6909c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 94148,
"upload_time": "2024-02-15T00:15:54",
"upload_time_iso_8601": "2024-02-15T00:15:54.295648Z",
"url": "https://files.pythonhosted.org/packages/52/b5/a00c30b443acb3dda52d7afcda06c251e5b9641debf42ac30f5c1f660ec5/trovares_connector-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9015e338fd23c741a329f5d8fa77bc14dfc75ff6f3cbb6bd06db523520b7a90",
"md5": "9caa18d8831afe747cf555fcbace62c2",
"sha256": "2e2161e383f09beb83c321b7c2cfed0e4ac9f57700d2dc9afb56f0fddfd3ae5b"
},
"downloads": -1,
"filename": "trovares_connector-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "9caa18d8831afe747cf555fcbace62c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 108199,
"upload_time": "2024-02-15T00:15:57",
"upload_time_iso_8601": "2024-02-15T00:15:57.421871Z",
"url": "https://files.pythonhosted.org/packages/b9/01/5e338fd23c741a329f5d8fa77bc14dfc75ff6f3cbb6bd06db523520b7a90/trovares_connector-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 00:15:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "trovares",
"github_project": "trovares_connector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "trovares-connector"
}
JSON
