Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
igorborgest committed Oct 26, 2019
1 parent 5331776 commit 29f0d26
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@
* Create EMR cluster (For humans) (NEW :star:)
* Terminate EMR cluster (NEW :star:)
* Get EMR cluster state (NEW :star:)
* Submit EMR step (For humans) (NEW :star:)
* Submit EMR step(s) (For humans) (NEW :star:)
* Get EMR step state (NEW :star:)
* Get EMR step state (NEW :star:)
* Athena query to receive the result as python primitives (*Iterable[Dict[str, Any]*) (NEW :star:)

## Installation

Expand Down Expand Up @@ -282,6 +284,14 @@ cluster_id = session.emr.create_cluster(
print(cluster_id)
```

#### Athena query to receive the result as python primitives (*Iterable[Dict[str, Any]*)

```py3
session = awswrangler.Session()
for row in session.athena.query(query="...", database="..."):
print(row)
```

## Diving Deep


Expand Down
9 changes: 9 additions & 0 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,12 @@ Create EMR cluster
key_pair_name=None,
)
print(cluster_id)
Athena query to receive the result as python primitives (Iterable[Dict[str, Any])
`````````````````````````````````````````````````````````````````````````````````

.. code-block:: python
session = awswrangler.Session()
for row in session.athena.query(query="...", database="..."):
print(row)
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ General
* Create EMR cluster (For humans) (NEW)
* Terminate EMR cluster (NEW)
* Get EMR cluster state (NEW)
* Submit EMR step (For humans) (NEW)
* Submit EMR step(s) (For humans) (NEW)
* Get EMR step state (NEW)
* Athena query to receive the result as python primitives (Iterable[Dict[str, Any]) (NEW)


Table Of Contents
Expand Down

0 comments on commit 29f0d26

Please sign in to comment.