Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2292 #14

Merged
merged 2 commits into from
Nov 14, 2024
Merged

DOC-2292 #14

merged 2 commits into from
Nov 14, 2024

Conversation

Tushar-TG-14
Copy link
Contributor

No description provided.

However, it is important to note that there will be a performance overhead when using pyTigerGraph compared to using cURL-like requests directly to the TigerGraph REST++ API.
This is because pyTigerGraph is a Python package that wraps the REST++ API and adds additional functionality such as URL building, logging, and authentication handling, as well as error checking.
pyTigerGraph is a feature-rich package that allows you to interact with TigerGraph databases using Python.
It enhances the REST++ API by adding extra features, such as URL setup, log creation, authentication, and error checks.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It enhances the REST++ API by adding extra features, such as URL setup, log creation, authentication, and error checks.
It enhances TigerGraph's REST API by adding extra features, such as URL setup, log creation, authentication, and error checks.

REST is a well-known industry concept. REST++ is the name of a TigerGraph-specific component, which handles only a subset of TigerGraph's REST API requests.

This is because pyTigerGraph is a Python package that wraps the REST++ API and adds additional functionality such as URL building, logging, and authentication handling, as well as error checking.
pyTigerGraph is a feature-rich package that allows you to interact with TigerGraph databases using Python.
It enhances the REST++ API by adding extra features, such as URL setup, log creation, authentication, and error checks.
Therefore, pyTigerGraph may perform slower than direct cURL requests to the TigerGraph REST++ API.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Therefore, pyTigerGraph may perform slower than direct cURL requests to the TigerGraph REST++ API.
Therefore, pyTigerGraph may perform slower than direct HTTP requests to the TigerGraph REST++ API.

Technically:
REST is an architectural style for client-server communication.
HTTP is the most common communication protocol used to implement REST; TigerGraph uses HTTP.
cURL is the most common utility used to send and receive HTTP messages in Linux. This is the customer's choice. They don't have to use cURL to make use of TigerGraph's RESTful HTTP endpoints.

@Tushar-TG-14 Tushar-TG-14 merged commit 86e6a37 into v1.8 Nov 14, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants