generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 41
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Current Situation
The README currently states:
dy scancommand executes Scan API internally to retrieve all items in the table.
This description suggests that dy scan is intended to retrieve all items, which may cause confusion about the difference between dy scan and dy import.
Proposed Change
The documentation should clarify that:
dy scanis primarily for inspecting/sampling table items (to see what typical items look like)dy importis for retrieving all items from a table
Suggested Documentation Update
`dy scan` command executes Scan API internally with a default limit.
To retrieve all items from a table, use `dy import` command.Context
This came up in the discussion of #278 and #279, where we're considering the design of pagination in dy scan. Clarifying the intended purpose of each command will help guide these design decisions.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation