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
* Backport changes from development
* Delete travis file
* Backport version checking
* Backport pbutils fixes
* Backport test write path
* Backport test suite changes
V3IO Frames (**"Frames"**) is a multi-model open-source data-access library that provides a unified high-performance DataFrame API for working with different types of data sources (backends).
7
-
The library was developed by Iguazio to simplify working with data in the [Iguazio Data Science Platform](https://www.iguazio.com) (**"the platform"**), but it can be extended to support additional backend types.
8
-
9
-
> **Note:** For a full API reference of the Frames platform backends, including detailed examples, see the Frames API reference in [the platform documentation](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/).
7
+
The library was developed by Iguazio to simplify working with data in the [Iguazio MLOps Platform](https://www.iguazio.com) (**"the platform"**), but it can be extended to support additional backend types.
10
8
11
9
#### In This Document
12
10
@@ -39,7 +37,7 @@ The library was developed by Iguazio to simplify working with data in the [Iguaz
39
37
<aid="python-version"></a>
40
38
#### Python Version
41
39
42
-
The current version of Frames supports Python 3.6 and 3.7.
40
+
The current version of Frames supports Python 3.7 and 3.9.
43
41
44
42
<aid="initialization"></a>
45
43
#### Initialization
@@ -59,15 +57,12 @@ All Frames client methods receive a [`backend`](#client-method-param-backend) pa
59
57
Frames currently supports the following backend types:
60
58
61
59
-`nosql` | `kv`— a platform NoSQL (key/value) table.
62
-
See the [platform NoSQL backend API reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/nosql/).
63
60
<br/><br/>
64
61
> **Note:** The documentation uses the `"nosql"` alias to the `"kv"` type, which was added in Frames v0.6.10-v0.9.13; `"kv"` is still supported for backwards compatibility with earlier releases.
65
62
-`stream`— a platform data stream **[Tech Preview]**.
66
63
<!-- [FRAMES-STREAMING-NO-SUPPORT]
67
-
See the [platform streaming backend API reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/stream/).
68
64
-->
69
65
-`tsdb`— a time-series database (TSDB).
70
-
See the [platform TSDB backend API reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/tsdb/).
71
66
-`csv`— a comma-separated-value (CSV) file.
72
67
This backend type is used only for testing purposes.
73
68
@@ -91,7 +86,6 @@ The `Client` class features the following methods for supporting operations on a
91
86
92
87
When creating a Frames client, you must provide valid credentials for accessing the backend data, which Frames will use to identify the identity of the user.
93
88
This can be done by using any of the following alternative methods (documented in order of precedence).
94
-
For more information about the user authentication for the platform backends, see the [platform documentation](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/overview/#user-authentication):
95
89
96
90
- <aid="user-auth-client-const-params"></a>Provide the authentication credentials in the call to the [`Client` constructor](#client-constructor)— either by setting the [`token`](#client-param-token) parameter to a valid authentication token (access key) or by setting the [`user`](#client-param-user) and [`password`](#client-param-password) parameters to a username and password.
97
91
Note that you cannot set the token parameter concurrently with the username and password parameters.
- <aid="client-param-address"></a>**address**— The address of the Frames service (`framesd`).
126
120
Use the `grpc://` prefix for gRPC (default; recommended) or the `http://` prefix for HTTP.
127
-
When running locally on the platform, set this parameter to `framesd:8081` to use the gRPC (recommended) or to `framesd:8080` to use HTTP; for more information, see the [platform documentation](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/client-constructor/).
121
+
When running locally on the platform, set this parameter to `framesd:8081` to use the gRPC (recommended) or to `framesd:8080` to use HTTP.
128
122
129
123
-**Type:**`str`
130
124
-**Requirement:** Required
@@ -252,7 +246,7 @@ All Frames backends that support the `create` method support the following commo
252
246
<a id="method-create-params-tsdb"></a>
253
247
#### `tsdb` Backend `create` Parameters
254
248
255
-
The following `create` parameters are specific to the `tsdb` backend and are passed as keyword arguments via the `kw` parameter; for more information and examples, see the platform's [Frames TSDB-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/tsdb/create/):
249
+
The following `create` parameters are specific to the `tsdb` backend and are passed as keyword arguments via the `kw` parameter:
@@ -279,8 +273,7 @@ The following `create` parameters are specific to the `tsdb` backend and are pas
279
273
<a id="method-create-params-stream"></a>
280
274
#### `stream` Backend `create` Parameters
281
275
282
-
The following `create` parameters are specific to the `stream` backend and are passed as keyword arguments via the `kw` parameter<!--; for more information and examples, see the platform's [Frames streaming-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/stream/create/)-->:
283
-
<!-- [FRAMES-STREAMING-NO-SUPPORT] -->
276
+
The following `create` parameters are specific to the `stream` backend and are passed as keyword arguments via the `kw` parameter:
284
277
285
278
-<a id="method-create-stream-param-shards"></a>**shards**— The number of stream shards to create.
286
279
@@ -385,7 +378,7 @@ All Frames backends that support the `write` method support the following common
385
378
<a id="method-write-params-nosql"></a>
386
379
#### `nosql` Backend `write` Parameters
387
380
388
-
The following `write` parameters are specific to the `nosql` backend; for more information and examples, see the platform's [Frames NoSQL-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/nosql/write/):
381
+
The following `write` parameters are specific to the `nosql` backend:
389
382
390
383
<!--
391
384
-<a id="method-write-nosql-param-expression"></a>**expression** (Optional) (default: `None`) — A platform update expression that determines how to update the table forall items in the DataFrame.
@@ -420,7 +413,7 @@ client.write(backend="nosql", table="mytable", dfs=df, expression="city='NY'", c
420
413
<a id="method-write-params-tsdb"></a>
421
414
#### `tsdb` Backend `write` Parameters
422
415
423
-
The following `write` parameter descriptions are specific to the `tsdb` backend; for more information and examples, see the platform's [Frames TSDB-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/tsdb/write/):
416
+
The following `write` parameter descriptions are specific to the `tsdb` backend:
424
417
425
418
-<a id="method-write-tsdb-param-labels"></a>**labels**— A dictionary of metric labels of the format`{<label>: <value>[, <label>: <value>, ...]}` to apply to all the DataFrame rows.
426
419
For example, `{"os": "linux", "arch": "x86"}`.
@@ -522,7 +515,7 @@ All Frames backends that support the `read` method support the following common
522
515
<a id="method-read-params-nosql"></a>
523
516
#### `nosql` Backend `read` Parameters
524
517
525
-
The following `read` parameters are specific to the `nosql` backend; for more information and examples, see the platform's [Frames NoSQL-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/nosql/read/):
518
+
The following `read` parameters are specific to the `nosql` backend:
526
519
527
520
-<a id="method-read-nosql-param-max_rows_in_msg"></a>**max_rows_in_msg**— The maximum number of rows per message.
528
521
@@ -547,7 +540,7 @@ The following parameters are passed as keyword arguments via the `kw` parameter:
547
540
<a id="method-read-params-tsdb"></a>
548
541
#### `tsdb` Backend `read` Parameters
549
542
550
-
The following `read` parameters are specific to the `tsdb` backend; for more information and examples, see the platform's [Frames TSDB-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/tsdb/read/):
543
+
The following `read` parameters are specific to the `tsdb` backend:
551
544
552
545
-<a id="method-read-tsdb-param-group_by"></a>**group_by****[Tech Preview]**— A group-by query string.
553
546
<br/>
@@ -615,8 +608,7 @@ The following parameters are passed as keyword arguments via the `kw` parameter:
615
608
<a id="method-read-params-stream"></a>
616
609
#### `stream` Backend `read` Parameters
617
610
618
-
The following `read` parameters are specific to the `stream` backend and are passed as keyword arguments via the `kw` parameter<!--; for more information and examples, see the platform's [Frames streaming-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/stream/read/)-->:
619
-
<!-- [FRAMES-STREAMING-NO-SUPPORT] -->
611
+
The following `read` parameters are specific to the `stream` backend and are passed as keyword arguments via the `kw` parameter:
The following `delete` parameters are specific to the `nosql` backend; for more information and examples, see the platform's [Frames NoSQL-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/nosql/delete/):
717
+
The following `delete` parameters are specific to the `nosql` backend:
726
718
727
719
-<a id="method-delete-nosql-param-filter"></a>**filter**— A filter expression that identifies specific items to delete.
728
720
@@ -733,7 +725,7 @@ The following `delete` parameters are specific to the `nosql` backend; for more
733
725
<a id="method-delete-params-tsdb"></a>
734
726
#### `tsdb` Backend `delete` Parameters
735
727
736
-
The following `delete` parameters are specific to the `tsdb` backend; for more information and examples, see the platform's [Frames TSDB-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/tsdb/delete/):
728
+
The following `delete` parameters are specific to the `tsdb` backend:
737
729
738
730
-<a id="method-delete-tsdb-param-start"></a>**start**— Start (minimum) time for the delete operation — i.e., delete only items whose data sample time is at or after (`>=`) the specified start time.
739
731
@@ -822,7 +814,7 @@ All Frames backends that support the `execute` method support the following comm
822
814
<a id="method-execute-nosql-cmds"></a>
823
815
#### `nosql` Backend `execute` Commands
824
816
825
-
The following `execute` commands are specific to the `nosql` backend; for more information and examples, see the platform's [Frames NoSQL-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/nosql/execute/):
817
+
The following `execute` commands are specific to the `nosql` backend:
826
818
827
819
-<a id="method-execute-nosql-cmd-infer"></a>**infer | infer_schema**— Infers the data schema of a given NoSQL table and creates a schema filefor the table.
828
820
@@ -845,8 +837,7 @@ The following `execute` commands are specific to the `nosql` backend; for more i
845
837
<a id="method-execute-stream-cmds"></a>
846
838
#### `stream` Backend `execute` Commands
847
839
848
-
The following `execute` commands are specific to the `stream` backend<!--; for more information and examples, see the platform's [Frames streaming-backend reference](https://www.iguazio.com/docs/latest-release/data-layer/reference/frames/stream/execute/)-->:
849
-
<!-- [FRAMES-STREAMING-NO-SUPPORT] -->
840
+
The following `execute` commands are specific to the `stream` backend:
850
841
851
842
-<a id="method-execute-stream-cmd-put"></a>**put**— Adds records to a stream shard.
Copy file name to clipboardExpand all lines: clients/py/v3io_frames/http.py
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -247,13 +247,20 @@ def _check_version(self):
247
247
exceptjson.JSONDecodeErroraserr:
248
248
raiseVersionError(str(err))
249
249
250
-
version=out.get('version')
251
-
ifnotversion:
250
+
server_version=out.get('version')
251
+
ifserver_version.startswith("v"):
252
+
server_version=server_version[1:]
253
+
ifnotserver_version:
252
254
warnings.warn("Warning - Cannot resolve server version. Make sure client version is compatible.")
253
255
return
254
256
255
-
if__version__!=version:
256
-
warnings.warn("Warning - Server version \'"+version+"\' is different from client version \'"+__version__+"\'. Some operations may not work as expected.")
0 commit comments