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

Add documentation for ome/omero-py#418 #2441

Merged
merged 3 commits into from
Jul 18, 2024
Merged
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
52 changes: 51 additions & 1 deletion omero/developers/Tables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,22 @@ Main methods
the table.
:return: The requested rows as a :class:`~omero.grid.Data` object.

.. note:: If you do not need the row numbers that match your read
returned in the :class:`~omero.grid.Data` object you can set
`omero.tables.include_row_numbers` to `false` in the Ice
context passed when you make the call.

For example:

::

readCoordinates(
[0], # rowNumbers
{
"omero.tables.include_row_numbers": "false"
}
)

.. method:: read(colNumbers, start, stop)

Read a subset of columns and consecutive rows from a table.
Expand All @@ -199,7 +215,24 @@ Main methods

.. note:: `start=0, stop=0` currently returns the first row instead
of empty as would be expected using the normal Python range
semantics. This may change in future.
semantics. This may change in future. If you do not need the
row numbers that match your read returned in the
:class:`~omero.grid.Data` object you can set
`omero.tables.include_row_numbers` to `false` in the Ice
context passed when you make the call.

For example:

::

read(
[0], # colNumbers
0, # start
2, # stop
{
"omero.tables.include_row_numbers": "false"
}
)

.. method:: slice(colNumbers, rowNumbers)

Expand All @@ -214,6 +247,23 @@ Main methods
:return: The requested columns and rows as a
:class:`~omero.grid.Data` object.

.. note:: If you do not need the row numbers that match your read
returned in the :class:`~omero.grid.Data` object you can set
`omero.tables.include_row_numbers` to `false` in the Ice
context passed when you make the call.

For example:

::

slice(
[0], # colNumbers
[0, 1], # rowNumbers
{
"omero.tables.include_row_numbers": "false"
}
)

.. method:: getWhereList(condition, variables, start, stop, step)

Run a query on a table, see :ref:`tables-query-language`.
Expand Down