From cd839d79099b3154d3ac0e18c40ec129f37a700a Mon Sep 17 00:00:00 2001 From: Sharon Lifshitz Date: Thu, 26 Sep 2019 17:51:57 +0300 Subject: [PATCH] [DOC] Frames GS: Add TSDB read parameters info [IG-12272 IG-12092] --- getting-started/frames.ipynb | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/getting-started/frames.ipynb b/getting-started/frames.ipynb index b9df2fc0..d9a15877 100644 --- a/getting-started/frames.ipynb +++ b/getting-started/frames.ipynb @@ -2823,7 +2823,12 @@ "\n", "### Read from the TSDB Table\n", "\n", - "Use the `read` method of the Frames client with the `tsdb` backend to read data from your TSDB table (i.e., query the database)." + "Use the `read` method of the Frames client with the `tsdb` backend to read data from your TSDB table (i.e., query the database).
\n", + "You can define the target TSDB table either in the `table` parameter of the `read` method or within the query string set in the optional `query` parameter, as demonstrated in the following example.\n", + "When the query includes the target table, the `table` parameter (if set) is ignored.
\n", + "You can set the optional `multi_index` parameter to `True` to return labels as index columns, as demonstrated in the following example.\n", + "By default, only the metric sample-time primary-key attribute is returned as an index column.
\n", + "See the [Frames documentation](https://github.com/v3io/frames/blob/master/README.md) for more information about the supported parameters of the `read` method for the `tsdb` backend." ] }, {