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
+18Lines changed: 18 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -166,6 +166,24 @@ with omero2pandas.OMEROConnection(server='my.server', port=4064,
166
166
167
167
The context manager will handle session creation and cleanup automatically.
168
168
169
+
### Connection Management
170
+
171
+
omero2pandas keeps track of any active connector objects and shuts them down
172
+
safely when Python exits. Deleting all references to a connector will also
173
+
handle closing the connection to OMERO gracefully. You can also call
174
+
`connector.shutdown()` to close a connection manually.
175
+
176
+
By default omero2pandas also keeps active connections alive by pinging the
177
+
server once per minute (otherwise the session may timeout and require
178
+
reconnecting). This can be disabled as follows
179
+
180
+
```python
181
+
omero2pandas.connect_to_omero(keep_alive=False)
182
+
```
183
+
184
+
N.b. omero2pandas uses a different system from the native OMERO API's
185
+
`client.enableKeepAlive` function, using both is unnecessary.
186
+
169
187
### Querying tables
170
188
171
189
You can also supply [PyTables condition syntax](https://www.pytables.org/usersguide/condition_syntax.html) to the `read_table` and `download_table` functions.
0 commit comments