Skip to content

Commit

Permalink
[DOC] README: Filter out update-expression refs (not supported) [IG-1…
Browse files Browse the repository at this point in the history
…2272] (#291)

* [DOC] README: Filter out update-expression refs (not supported) [IG-12272]

* [PR #291] [DOC] README: Remove write expression param from example & fix DF var name [IG-12272]
  • Loading branch information
Sharon-iguazio authored and dinal committed Sep 24, 2019
1 parent b9fdec1 commit 08d5a63
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,22 @@ client.write(backend='kv', table='mytable', dfs=df)

#### backend specific parameters
##### KV
<!--
* expression=' ' (optional) - for detailed information on update expressions see [docs](https://www.iguazio.com/docs/reference/latest-release/expressions/update-expression/)
-->
<!-- [IntInfo] [c-no-update-expression-support] (24.9.19) See Bug IG-12510,
Requirement IG-5339, & DOC IG-12272. The original write example below had
an `expression` parameter:
v3c.write(backend='kv', table='mytable', dfs=df, expression='city="NY"', condition='age>14')
-->
* condition=' ' (optional) - for detailed information on condition expressions see [docs](https://www.iguazio.com/docs/reference/latest-release/expressions/condition-expression/)

Example:
```python
data = [['tom', 10, 'TLV'], ['nick', 15, 'Berlin'], ['juli', 14, 'NY']]
df = pd.DataFrame(data, columns = ['name', 'age', 'city'])
df.set_index('name')
v3c.write(backend='kv', table='mytable', dfs=tsdf, expression='city="NY"', condition='age>14')
v3c.write(backend='kv', table='mytable', dfs=df, condition='age>14')
```

### Read
Expand Down Expand Up @@ -179,9 +186,12 @@ Currently no `execute` commands are available for the TSDB backend.

##### KV
* infer, inferschema - inferring and creating a schema file for a given kv table.
Example: `client.execute(backend='kv', table='mytable', command='infer')`
Example: `client.execute(backend='kv', table='mytable', command='infer')`
<!--
* update - perform an update expression for a specific key.
Example: `client.execute(backend='kv', table='mytable', command='update', args={'key': 'somekey', 'expression': 'col2=30', 'condition': 'col3>15'})`
-->
<!-- [IntInfo] [c-no-update-expression-support] -->

##### Stream
* put - putting a new object to a stream.
Expand Down

0 comments on commit 08d5a63

Please sign in to comment.