View Source Ravix.Documents.Commands.GetDocumentsCommand (ravix v0.1.0)
Command to fetch documents from RavenDB
fields
Fields
- ids: List of document ids
- includes: Path of the referenced documents that should be included
- metadata_only: If the response should contain only the metadata
- start: from which position should the returned documents start
- page_size: number of documents that should be returned
- counter_includes: List of counters to be returned
Link to this section Summary
Functions
Parses the response of the GetCommand
Link to this section Types
@type t() :: %Ravix.Documents.Commands.GetDocumentsCommand{ counter_includes: [String.t()] | nil, data: term(), files: term(), headers: term(), ids: [String.t()], includes: [String.t()] | nil, is_raft_request: term(), is_read_request: term(), metadata_only: boolean() | nil, method: term(), page_size: non_neg_integer() | nil, raft_unique_request_id: term(), start: non_neg_integer() | nil, timeout: term(), url: term(), use_stream: term() }
Link to this section Functions
@spec parse_response(Ravix.Documents.Session.State.t(), map()) :: [ includes: list(), results: list() ]
Parses the response of the GetCommand
parameters
Parameters
- session_state: The session state where this command was called
- documents_response: Response from the database call
returns
Returns
- List of results and includes