You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-55Lines changed: 28 additions & 55 deletions
Original file line number
Diff line number
Diff line change
@@ -307,7 +307,7 @@ These should match the relevant column type. Mapped variables are substituted in
307
307
A `variables` map usually isn't needed for simple queries. The basic condition string should automatically get converted to a meaningful type, but when this fails
308
308
replacing tricky elements with a variable may help.
309
309
310
-
### Remote registration
310
+
### Remote registration[Experimental - OMERO Plus Only]
311
311
312
312
For **OMERO Plus** installations which support TileDB as the OMERO.tables backend
313
313
it is possible to register tables in-place in a similar manner to in-place image
@@ -329,7 +329,7 @@ For this mode to be available extra dependencies must also be installed as follo
329
329
pip install omero2pandas[remote]
330
330
```
331
331
332
-
To activate this mode use `omero2pandas.upload_table` with arguments as
332
+
To use remote registration supply the `local_path` argument to `omero2pandas.upload_table` as
333
333
follows:
334
334
335
335
```python
@@ -339,22 +339,12 @@ db_path = omero2pandas.upload_table("/path/to/my_data.csv", "Name for table",
339
339
# Returns the path to the created tiledb file
340
340
```
341
341
342
-
Similar to regular table uploads, the input can be a dataframe in memory or a
343
-
csv file on disk. The input will be copied into a new TileDB database and
344
-
registered to OMERO in-place.
342
+
This will convert the table into a TileDB database which will be written to `local_path`, then attempt to
343
+
register this to OMERO in-place. For this to work the local_path needs to be visible on the server machine
344
+
as well (e.g. a network drive).
345
345
346
-
To perform this kind of registration you need to provide the `local_path` argument
347
-
to the standard `omero2pandas.upload_table` function (alongside required params for
348
-
a "normal" upload e.g. server connection details). The local path is the file path
349
-
where the tiledb file will be written to and registered to OMERO from.
350
-
If you provide a directory instead the tiledb file will be named based on the `table_name` argument.
351
-
352
-
Naturally, the OMERO server will need to be able to access the resulting tiledb file
353
-
in order to be registered. If the `local_path` is also visible from the server machine
354
-
(e.g. you're running the upload on the server itself) then that's sufficient. Otherwise
355
-
a `remote_path` argument is also available to tell the server where it should
356
-
find the table. This is typically needed if the tiledb file ends up mounted at a
357
-
different location between the local machine and the OMERO server.
346
+
If shared storage is mounted differently from the server's point of view, you can also supply the `remote_path`
347
+
parameter to declare where OMERO should find the resulting TileDB file.
358
348
359
349
For example, if registering from a Windows machine with a network drive to an OMERO server on Linux:
360
350
```python
@@ -370,52 +360,35 @@ is where that file will be from the OMERO server's point of view. No remote path
370
360
implies that both machines will see the file at the local path.
371
361
372
362
Note that when a table is registered remotely it is not part of the Managed Repository
373
-
used to store OMERO data. This means that it becomes the user's responsibility to
363
+
used to store OMERO data. This means that it becomes the **user's responsibility** to
374
364
update the table object on the OMERO server if the file is moved/deleted.
0 commit comments