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

Update the Get Started tutorial for Python connector #4197

Merged
merged 3 commits into from
May 22, 2024

Conversation

andreyaksenov
Copy link
Contributor

@andreyaksenov andreyaksenov commented May 17, 2024

Updated topics:

  • Connecting from Python
  • Python - removed unnecessary "quick start" and added a link to the updated tutorial.
  • Added a note about making requests to sharded clusters with the crud module (net.box/Go/Python tutorials).

The Connecting from Python tutorial has the same steps and uses the same database as the Connecting to a database using net.box and Connecting from Go tutorials. The upcoming C/C++ tutorials are going to have the same layout.

Note that the sample script referenced in the tutorial doesn't handle any connection/request errors for simplicity.

@andreyaksenov andreyaksenov linked an issue May 17, 2024 that may be closed by this pull request
@andreyaksenov andreyaksenov marked this pull request as ready for review May 20, 2024 12:25
Copy link
Member

@DifferentialOrange DifferentialOrange left a comment

Choose a reason for hiding this comment

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

Thank you, seems cool

@andreyaksenov andreyaksenov requested a review from p7nov May 21, 2024 13:51
Copy link
Contributor

@p7nov p7nov left a comment

Choose a reason for hiding this comment

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

LGTM 👍


To get connected to the Tarantool server, say this:
Now you can a client Python application that makes requests to this database.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Now you can a client Python application that makes requests to this database.
Now you can create a client Python application that makes requests to this database.


.. code-block:: python
``connection.insert()`` is used to insert a tuple to the space.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
``connection.insert()`` is used to insert a tuple to the space.
``conn.insert()`` is used to insert a tuple to the space.

Copy link
Contributor

Choose a reason for hiding this comment

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

or Connection.insert() if you refer to the library class instead of exact object in this example.
Same for occurrences of connection.<method_name> below in text.

@andreyaksenov andreyaksenov merged commit 1a39ddb into latest May 22, 2024
1 check failed
@andreyaksenov andreyaksenov deleted the python-connector branch May 22, 2024 07:22
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.

[Config] Update the Get Started tutorial for Python connector
3 participants