From 16eecd9a121de81e483f448ab0a52e2d22c7ed33 Mon Sep 17 00:00:00 2001 From: Chris Allan Date: Mon, 8 Jul 2024 12:17:20 +0000 Subject: [PATCH 1/3] Add documentation for ome/omero-py#418 --- omero/developers/Tables.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/omero/developers/Tables.rst b/omero/developers/Tables.rst index 0e42331283..aa62f37b77 100644 --- a/omero/developers/Tables.rst +++ b/omero/developers/Tables.rst @@ -199,7 +199,11 @@ 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. .. method:: slice(colNumbers, rowNumbers) @@ -214,6 +218,11 @@ 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. + .. method:: getWhereList(condition, variables, start, stop, step) Run a query on a table, see :ref:`tables-query-language`. From 743b01af9df495e82589b08fbb206b81a1e26097 Mon Sep 17 00:00:00 2001 From: Chris Allan Date: Thu, 11 Jul 2024 15:12:21 +0000 Subject: [PATCH 2/3] Add note to `readCoordinates()` --- omero/developers/Tables.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/omero/developers/Tables.rst b/omero/developers/Tables.rst index aa62f37b77..61ba209db9 100644 --- a/omero/developers/Tables.rst +++ b/omero/developers/Tables.rst @@ -185,6 +185,11 @@ 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. + .. method:: read(colNumbers, start, stop) Read a subset of columns and consecutive rows from a table. From 906d1b5848d3cc082f56dff8599864a8e7bff823 Mon Sep 17 00:00:00 2001 From: Chris Allan Date: Thu, 11 Jul 2024 15:20:37 +0000 Subject: [PATCH 3/3] Add examples --- omero/developers/Tables.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/omero/developers/Tables.rst b/omero/developers/Tables.rst index 61ba209db9..c9c40fe6f6 100644 --- a/omero/developers/Tables.rst +++ b/omero/developers/Tables.rst @@ -190,6 +190,17 @@ Main methods `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. @@ -210,6 +221,19 @@ Main methods `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) Read a subset of columns and rows (may be non-consecutive) from a @@ -228,6 +252,18 @@ Main methods `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`.