Skip to content

Move "Feature comparison" table to doc/book/connectors/__go.rst #2636

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

Merged
merged 7 commits into from
Jan 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 181 additions & 6 deletions doc/book/connectors/__go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,186 @@
Go
=====================================================================

The following connectors are available:

There are two connectors available:
* Tarantool-supported `go-tarantool <https://github.com/tarantool/go-tarantool>`__

* Tarantool-supported
`go-tarantool <https://github.com/tarantool/go-tarantool>`__
* Community-supported
`Tarantool Go client <https://github.com/FZambia/tarantool>`__

* Community-supported `viciious/go-tarantool <https://github.com/viciious/go-tarantool>`_

* Community-supported `FZambia/tarantool <https://github.com/FZambia/tarantool>`_.

Feature comparison
------------------

Last update: January 2022

.. list-table::
:header-rows: 1
:stub-columns: 1

* -
- `tarantool/go-tarantool <https://github.com/tarantool/go-tarantool>`_
- `viciious/go-tarantool <https://github.com/viciious/go-tarantool>`_
- `FZambia/tarantool <https://github.com/FZambia/tarantool>`_

* - License
- BSD 2-Clause
- MIT
- BSD 2-Clause

* - Last update
- 2022
- 2021
- 2021

* - Documentation
- README with examples, API described in code comments
- README with examples, code comments
- README with examples

* - Testing / CI / CD
- GitHub Actions
- Travis CI
- GitHub Actions

* - GitHub Stars
- 127
- 43
- 12

* - Static analysis
- No
- golint
- golangci-lint

* - Packaging
- go get
- go get
- go get

* - Code coverage
- No
- No
- No

* - msgpack driver
- `vmihailenco/msgpack/v2 <https://github.com/vmihailenco/msgpack/tree/v2>`_ (`#124 <https://github.com/tarantool/go-tarantool/issues/124>`_)
- `tinylib/msgp <https://github.com/tinylib/msgp>`_
- `vmihailenco/msgpack/v5 <https://github.com/vmihailenco/msgpack/tree/v5>`_

* - Async work
- Yes
- Yes
- Yes

* - Schema reload
- Yes (manual pull)
- Yes (manual pull)
- Yes (manual pull)

* - Space / index names
- Yes
- Yes
- Yes

* - Tuples as structures
- Yes (structure and marshall functions must be predefined in Go code)
- No
- Yes (structure and marshall functions must be predefined in Go code)

* - Access tuple fields by names
- Only if marshalled to structure
- No
- Only if marshalled to structure

* - `SQL <https://www.tarantool.io/en/doc/latest/reference/reference_sql/>`_ support
- No (`#62 <https://github.com/tarantool/go-tarantool/issues/62>`_)
- No (`#18 <https://github.com/viciious/go-tarantool/issues/18>`_, closed)
- No

* - `Interactive transactions <https://www.tarantool.io/en/doc/latest/book/box/stream/>`_
- No (`#101 <https://github.com/tarantool/go-tarantool/issues/101>`_)
- No
- No

* - `Varbinary <https://www.tarantool.io/en/doc/latest/book/box/data_model/>`_ support
- Yes (with in-built language tools)
- Yes (with in-built language tools)
- Yes (decodes to string by default, see `#6 <https://github.com/FZambia/tarantool/issues/6>`_)

* - `UUID <https://www.tarantool.io/en/doc/latest/book/box/data_model/>`_ support
- Yes
- No
- No

* - Decimal support
- No (`#96 <https://github.com/tarantool/go-tarantool/issues/96>`_)
- No
- No

* - `EXT_ERROR <https://www.tarantool.io/ru/doc/latest/dev_guide/internals/msgpack_extensions/#the-error-type>`_
support
- No
- No
- No

* - `Datetime <https://github.com/tarantool/tarantool/discussions/6244>`_ support
- No (`#118 <https://github.com/tarantool/go-tarantool/issues/118>`_)
- No
- No

* - `box.session.push() responses <https://www.tarantool.io/ru/doc/latest/reference/reference_lua/box_session/push/>`_
- No (`#67 <https://github.com/tarantool/go-tarantool/issues/67>`_)
- No (`#21 <https://github.com/viciious/go-tarantool/issues/21>`_)
- Yes

* - `Session settings <https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/_session_settings/>`_
- No
- No
- No

* - `Graceful shutdown <https://github.com/tarantool/tarantool/issues/5924>`_
- No
- No
- No

* - `IPROTO_ID (feature discovering) <https://github.com/tarantool/tarantool/issues/6253>`_
- No
- No
- No

* - `tarantool/crud <https://github.com/tarantool/crud>`_ support
- No
- No
- No

* - Connection pool
- Yes (round-robin failover, no balancing, master discovering planned in `#113 <https://github.com/tarantool/go-tarantool/issues/113>`_)
- No
- No

* - Transparent reconnecting
- Yes (see comments in `#129 <https://github.com/tarantool/go-tarantool/issues/129>`_)
- No (handle reconnects explicitly, refer to `#11 <https://github.com/viciious/go-tarantool/issues/11>`_)
- Yes (see comments in `#7 <https://github.com/FZambia/tarantool/issues/7>`_)

* - Transparent request retrying
- No
- No
- No

* - `Watchers <https://github.com/tarantool/tarantool/pull/6510>`_
- No
- No
- No

* - Language features
- No (`#48 <https://github.com/tarantool/go-tarantool/issues/48>`_)
- context
- context

* - Miscellaneous
- Supports `tarantool/queue <https://github.com/tarantool/queue>`_ API
- Can mimic a Tarantool instance (also as replica). Provides instrumentation for reading snapshot and xlog files
via `snapio module <https://github.com/viciious/go-tarantool/tree/master/snapio>`_
- API is experimental and breaking changes may happen
182 changes: 7 additions & 175 deletions doc/getting_started/getting_started_go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,178 +252,10 @@ To send bare Lua code for execution, use ``Eval``:
Feature comparison
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There are two more connectors from the open-source community available:
`viciious/go-tarantool <https://github.com/viciious/go-tarantool>`_ and
`FZambia/tarantool <https://github.com/FZambia/tarantool>`_.

Last update: January 2022

.. list-table::
:header-rows: 1
:stub-columns: 1

* -
- `tarantool/go-tarantool <https://github.com/tarantool/go-tarantool>`_
- `viciious/go-tarantool <https://github.com/viciious/go-tarantool>`_
- `FZambia/tarantool <https://github.com/FZambia/tarantool>`_

* - License
- BSD 2-Clause
- MIT
- BSD 2-Clause

* - Last update
- 2022
- 2021
- 2021

* - Documentation
- README with examples, API described in code comments
- README with examples, code comments
- README with examples

* - Testing / CI / CD
- GitHub Actions
- Travis CI
- GitHub Actions

* - GitHub Stars
- 127
- 43
- 12

* - Static analysis
- No
- golint
- golangci-lint

* - Packaging
- go get
- go get
- go get

* - Code coverage
- No
- No
- No

* - msgpack driver
- `vmihailenco/msgpack/v2 <https://github.com/vmihailenco/msgpack/tree/v2>`_ (`#124 <https://github.com/tarantool/go-tarantool/issues/124>`_)
- `tinylib/msgp <https://github.com/tinylib/msgp>`_
- `vmihailenco/msgpack/v5 <https://github.com/vmihailenco/msgpack/tree/v5>`_

* - Async work
- Yes
- Yes
- Yes

* - Schema reload
- Yes (manual pull)
- Yes (manual pull)
- Yes (manual pull)

* - Space / index names
- Yes
- Yes
- Yes

* - Tuples as structures
- Yes (structure and marshall functions must be predefined in Go code)
- No
- Yes (structure and marshall functions must be predefined in Go code)

* - Access tuple fields by names
- Only if marshalled to structure
- No
- Only if marshalled to structure

* - `SQL <https://www.tarantool.io/en/doc/latest/reference/reference_sql/>`_ support
- No (`#62 <https://github.com/tarantool/go-tarantool/issues/62>`_)
- No (`#18 <https://github.com/viciious/go-tarantool/issues/18>`_, closed)
- No

* - `Interactive transactions <https://www.tarantool.io/en/doc/latest/book/box/stream/>`_
- No (`#101 <https://github.com/tarantool/go-tarantool/issues/101>`_)
- No
- No

* - `Varbinary <https://www.tarantool.io/en/doc/latest/book/box/data_model/>`_ support
- Yes (with in-built language tools)
- Yes (with in-built language tools)
- Yes (decodes to string by default, see `#6 <https://github.com/FZambia/tarantool/issues/6>`_)

* - `UUID <https://www.tarantool.io/en/doc/latest/book/box/data_model/>`_ support
- Yes
- No
- No

* - Decimal support
- No (`#96 <https://github.com/tarantool/go-tarantool/issues/96>`_)
- No
- No

* - `EXT_ERROR <https://www.tarantool.io/ru/doc/latest/dev_guide/internals/msgpack_extensions/#the-error-type>`_
support
- No
- No
- No

* - `Datetime <https://github.com/tarantool/tarantool/discussions/6244>`_ support
- No (`#118 <https://github.com/tarantool/go-tarantool/issues/118>`_)
- No
- No

* - `box.session.push() responses <https://www.tarantool.io/ru/doc/latest/reference/reference_lua/box_session/push/>`_
- No (`#67 <https://github.com/tarantool/go-tarantool/issues/67>`_)
- No (`#21 <https://github.com/viciious/go-tarantool/issues/21>`_)
- Yes

* - `Session settings <https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/_session_settings/>`_
- No
- No
- No

* - `Graceful shutdown <https://github.com/tarantool/tarantool/issues/5924>`_
- No
- No
- No

* - `IPROTO_ID (feature discovering) <https://github.com/tarantool/tarantool/issues/6253>`_
- No
- No
- No

* - `tarantool/crud <https://github.com/tarantool/crud>`_ support
- No
- No
- No

* - Connection pool
- Yes (round-robin failover, no balancing, master discovering planned in `#113 <https://github.com/tarantool/go-tarantool/issues/113>`_)
- No
- No

* - Transparent reconnecting
- Yes (see comments in `#129 <https://github.com/tarantool/go-tarantool/issues/129>`_)
- No (handle reconnects explicitly, refer to `#11 <https://github.com/viciious/go-tarantool/issues/11>`_)
- Yes (see comments in `#7 <https://github.com/FZambia/tarantool/issues/7>`_)

* - Transparent request retrying
- No
- No
- No

* - `Watchers <https://github.com/tarantool/tarantool/pull/6510>`_
- No
- No
- No

* - Language features
- No (`#48 <https://github.com/tarantool/go-tarantool/issues/48>`_)
- context
- context

* - Miscellaneous
- Supports `tarantool/queue <https://github.com/tarantool/queue>`_ API
- Can mimic a Tarantool instance (also as replica)
- API is experimental and breaking changes may happen
There are two more connectors from the open-source community:

* `viciious/go-tarantool <https://github.com/viciious/go-tarantool>`_

* `FZambia/tarantool <https://github.com/FZambia/tarantool>`_.

See the :ref:`feature comparison table <index_connector_go>` of all Go connectors available.
8 changes: 8 additions & 0 deletions doc/getting_started/getting_started_python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -245,3 +245,11 @@ To send bare Lua code for execution, use ``eval``:

>>> connection.eval('return 4 + 5')
9

.. _getting_started-python-comparison:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Feature comparison
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

See the :ref:`feature comparison table <index_connector_py>` of all Python connectors available.
Loading