Skip to content

Commit

Permalink
Update sink documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davidanthoff committed Apr 26, 2017
1 parent f090f7c commit 21847ba
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions docs/src/sinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ println(x)
Query.DataValue{String}["John","Sally","Kirk"]
```

## DataFrame
## DataFrame, DataTable and TypedTable

The statement `@collect DataFrame` will materialize the query results into a new `DataFrame` instance. This statement only works if the last projection statement transformed the results into a `NamedTuple`, for example by using the `{}` syntax.
The statement `@collect TableType` (with `TableType` being one of `DatFrame`, `DataTable` or `TypedTable`) will materialize the query results into a new instance of that type. This statement only works if the last projection statement transformed the results into a `NamedTuple`, for example by using the `{}` syntax.

### Example

Expand Down Expand Up @@ -91,3 +91,29 @@ If a `DataStreams` sink is passed to the `@collect` statement, the results of th
### Example

[TODO]

## TimeArray

The statement `@collect TimeArray` will materialize the query results into
a new `TimeSeries.TimeArray` instance. This statement only works if the
last projection statement transformed the results into a `NamedTuple`,
for example by using the `{}` syntax, and this `NamedTuple` has one field
named `timestamp` that is of a type that can be used as a time index in
the `TimeArray` type.

### Example

[TODO]

## IndexedTable

The statement `@collect IndexedTable` will materialize the query results
into a new `IndexedTables.IndexedTable` instance. This statement only
works if the last projection statement transformed the results into a
`NamedTuple`, for example by using the `{}` syntax. The last column of
the result table will be the data column, all other columns will be index
columns.

### Example

[TODO]

0 comments on commit 21847ba

Please sign in to comment.