Skip to content

Commit 88f061b

Browse files
jeremydalyjeremydaly
committed
fix query table in readme
1 parent 1b53fe7 commit 88f061b

File tree

1 file changed

+58
-58
lines changed

1 file changed

+58
-58
lines changed

‎README.md‎

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -156,68 +156,68 @@ If you like working with ORMs, that's great, and you should definitely give thes
156156
- [Features](#features)
157157
- [Conventions, Motivations, and Migrations from v0.1](#conventions-motivations-and-migrations-from-v01)
158158
- [Tables](#tables)
159-
- [Specifying Table Definitions](#specifying-table-definitions)
160-
- [Table Attributes](#table-attributes)
161-
- [Table Indexes](#table-indexes)
159+
- [Specifying Table Definitions](#specifying-table-definitions)
160+
- [Table Attributes](#table-attributes)
161+
- [Table Indexes](#table-indexes)
162162
- [Entities](#entities)
163-
- [Specifying Entity Definitions](#specifying-entity-definitions)
164-
- [Entity Attributes](#entity-attributes)
165-
- [Using a `string`](#using-a-string)
166-
- [Using an `object`](#using-an-object)
167-
- [Using an `array` for composite keys](#using-an-array-for-composite-keys)
168-
- [Customize defaults with a `function`](#customize-defaults-with-a-function)
163+
- [Specifying Entity Definitions](#specifying-entity-definitions)
164+
- [Entity Attributes](#entity-attributes)
165+
- [Using a `string`](#using-a-string)
166+
- [Using an `object`](#using-an-object)
167+
- [Using an `array` for composite keys](#using-an-array-for-composite-keys)
168+
- [Customize defaults with a `function`](#customize-defaults-with-a-function)
169169
- [Table Properties](#table-properties)
170-
- [get/set `DocumentClient`](#getset-documentclient)
171-
- [get/set `entities`](#getset-entities)
172-
- [get/set `autoExecute`](#getset-autoexecute)
173-
- [get/set `autoParse`](#getset-autoparse)
170+
- [get/set `DocumentClient`](#getset-documentclient)
171+
- [get/set `entities`](#getset-entities)
172+
- [get/set `autoExecute`](#getset-autoexecute)
173+
- [get/set `autoParse`](#getset-autoparse)
174174
- [Table Methods](#table-methods)
175-
- [query(partitionKey [,options] [,parameters])](#querypartitionkey-options-parameters)
176-
- [Return Data](#return-data)
177-
- [scan([options] [,parameters])](#scanoptions-parameters)
178-
- [Return Data](#return-data-1)
179-
- [batchGet(items [,options] [,parameters])](#batchgetitems-options-parameters)
180-
- [Specifying options for multiple tables](#specifying-options-for-multiple-tables)
181-
- [Return Data](#return-data-2)
182-
- [batchWrite(items [,options] [,parameters])](#batchwriteitems-options-parameters)
183-
- [Return Data](#return-data-3)
184-
- [transactGet(items [,options] [,parameters])](#transactgetitems-options-parameters)
185-
- [Accessing items from multiple tables](#accessing-items-from-multiple-tables)
186-
- [Return Data](#return-data-4)
187-
- [transactWrite(items [,options] [,parameters])](#transactwriteitems-options-parameters)
188-
- [Return Data](#return-data-5)
189-
- [parse(entity, input [,include])](#parseentity-input-include)
190-
- [get(entity, key [,options] [,parameters])](#getentity-key-options-parameters)
191-
- [delete(entity, key [,options] [,parameters])](#deleteentity-key-options-parameters)
192-
- [put(entity, item [,options] [,parameters])](#putentity-item-options-parameters)
193-
- [update(entity, key [,options] [,parameters])](#updateentity-key-options-parameters)
175+
- [query(partitionKey [,options] [,parameters])](#querypartitionkey-options-parameters)
176+
- [Return Data](#return-data)
177+
- [scan([options] [,parameters])](#scanoptions-parameters)
178+
- [Return Data](#return-data-1)
179+
- [batchGet(items [,options] [,parameters])](#batchgetitems-options-parameters)
180+
- [Specifying options for multiple tables](#specifying-options-for-multiple-tables)
181+
- [Return Data](#return-data-2)
182+
- [batchWrite(items [,options] [,parameters])](#batchwriteitems-options-parameters)
183+
- [Return Data](#return-data-3)
184+
- [transactGet(items [,options] [,parameters])](#transactgetitems-options-parameters)
185+
- [Accessing items from multiple tables](#accessing-items-from-multiple-tables)
186+
- [Return Data](#return-data-4)
187+
- [transactWrite(items [,options] [,parameters])](#transactwriteitems-options-parameters)
188+
- [Return Data](#return-data-5)
189+
- [parse(entity, input [,include])](#parseentity-input-include)
190+
- [get(entity, key [,options] [,parameters])](#getentity-key-options-parameters)
191+
- [delete(entity, key [,options] [,parameters])](#deleteentity-key-options-parameters)
192+
- [put(entity, item [,options] [,parameters])](#putentity-item-options-parameters)
193+
- [update(entity, key [,options] [,parameters])](#updateentity-key-options-parameters)
194194
- [Entity Properties](#entity-properties)
195-
- [get/set `table`](#getset-table)
196-
- [get `DocumentClient`](#get-documentclient)
197-
- [get/set `autoExecute`](#getset-autoexecute-1)
198-
- [get/set `autoParse`](#getset-autoparse-1)
199-
- [get `partitionKey`](#get-partitionkey)
200-
- [get `sortKey`](#get-sortkey)
195+
- [get/set `table`](#getset-table)
196+
- [get `DocumentClient`](#get-documentclient)
197+
- [get/set `autoExecute`](#getset-autoexecute-1)
198+
- [get/set `autoParse`](#getset-autoparse-1)
199+
- [get `partitionKey`](#get-partitionkey)
200+
- [get `sortKey`](#get-sortkey)
201201
- [Entity Methods](#entity-methods)
202-
- [attribute(attribute)](#attributeattribute)
203-
- [parse(input [,include])](#parseinput-include)
204-
- [get(key [,options] [,parameters])](#getkey-options-parameters)
205-
- [delete(key [,options] [,parameters])](#deletekey-options-parameters)
206-
- [put(item [,options] [,parameters])](#putitem-options-parameters)
207-
- [update(key [,options] [,parameters])](#updatekey-options-parameters)
208-
- [Updating an attribute](#updating-an-attribute)
209-
- [Removing an attribute](#removing-an-attribute)
210-
- [Adding a number to a `number` attribute](#adding-a-number-to-a-number-attribute)
211-
- [Adding values to a `set`](#adding-values-to-a-set)
212-
- [Deleting values from a `set`](#deleting-values-from-a-set)
213-
- [Appending (or prepending) values to a `list`](#appending-or-prepending-values-to-a-list)
214-
- [Remove items from a `list`](#remove-items-from-a-list)
215-
- [Update items in a `list`](#update-items-in-a-list)
216-
- [Update nested data in a `map`](#update-nested-data-in-a-map)
217-
- [query(partitionKey [,options] [,parameters])](#querypartitionkey-options-parameters-1)
218-
- [scan([options] [,parameters])](#scanoptions-parameters-1)
202+
- [attribute(attribute)](#attributeattribute)
203+
- [parse(input [,include])](#parseinput-include)
204+
- [get(key [,options] [,parameters])](#getkey-options-parameters)
205+
- [delete(key [,options] [,parameters])](#deletekey-options-parameters)
206+
- [put(item [,options] [,parameters])](#putitem-options-parameters)
207+
- [update(key [,options] [,parameters])](#updatekey-options-parameters)
208+
- [Updating an attribute](#updating-an-attribute)
209+
- [Removing an attribute](#removing-an-attribute)
210+
- [Adding a number to a `number` attribute](#adding-a-number-to-a-number-attribute)
211+
- [Adding values to a `set`](#adding-values-to-a-set)
212+
- [Deleting values from a `set`](#deleting-values-from-a-set)
213+
- [Appending (or prepending) values to a `list`](#appending-or-prepending-values-to-a-list)
214+
- [Remove items from a `list`](#remove-items-from-a-list)
215+
- [Update items in a `list`](#update-items-in-a-list)
216+
- [Update nested data in a `map`](#update-nested-data-in-a-map)
217+
- [query(partitionKey [,options] [,parameters])](#querypartitionkey-options-parameters-1)
218+
- [scan([options] [,parameters])](#scanoptions-parameters-1)
219219
- [Filters and Conditions](#filters-and-conditions)
220-
- [Complex Filters and Conditions](#complex-filters-and-conditions)
220+
- [Complex Filters and Conditions](#complex-filters-and-conditions)
221221
- [Projection Expressions](#projection-expressions)
222222
- [Adding Custom Parameters and Clauses](#adding-custom-parameters-and-clauses)
223223
- [Additional References](#additional-references)
@@ -520,13 +520,13 @@ The `query()` method accepts three arguments. The first argument is used to spec
520520
The second argument is an `options` object that specifies the details of your query. The following options are all optional (corresponding Query API references in parentheses):
521521

522522
| Option | Type | Description |
523-
| ---------- | :-----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
523+
| ---------- | :-----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
524524
| index | `string` | Name of secondary index to query. If not specified, the query executes on the primary index. The index must include the table's `entityField` attribute for automatic parsing of returned data. (IndexName) |
525525
| limit | `number` | The maximum number of items to retrieve per query. (Limit) |
526526
| reverse | `boolean` | Reverse the order or returned items. (ScanIndexForward) |
527527
| consistent | `boolean` | Enable a consistent read of the items (ConsistentRead) |
528528
| capacity | `string` | Return the amount of consumed capacity. One of either `none`, `total`, or `indexes` (ReturnConsumedCapacity) |
529-
| select | `string` | The attributes to be returned in the result. One of either `string` | `all_attributes`, `all_projected_attributes`, `specific_attributes`, or `count` (Select) |
529+
| select | `string` | The attributes to be returned in the result. One of either `all_attributes`, `all_projected_attributes`, `specific_attributes`, or `count` (Select) |
530530
| eq | same as `sortKey` | Specifies `sortKey` condition to be _equal_ to supplied value. (KeyConditionExpression) |
531531
| lt | same as `sortKey` | Specifies `sortKey` condition to be _less than_ supplied value. (KeyConditionExpression) |
532532
| lte | same as `sortKey` | Specifies `sortKey` condition to be _less than or equal to_ supplied value. (KeyConditionExpression) |

0 commit comments

Comments
 (0)