Skip to content

Commit

Permalink
Update 'Vespa-CLI' reference documentation. (#3612)
Browse files Browse the repository at this point in the history
Co-authored-by: kkraune <[email protected]>
  • Loading branch information
github-actions[bot] and kkraune authored Feb 4, 2025
1 parent f9f1793 commit f2375c3
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
1 change: 0 additions & 1 deletion en/reference/vespa-cli/vespa.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ vespa [flags]
* [vespa document](vespa_document.html) - Issue a single document operation to Vespa
* [vespa feed](vespa_feed.html) - Feed multiple document operations to Vespa
* [vespa fetch](vespa_fetch.html) - Download a deployed application package
* [vespa inspect](vespa_inspect.html) - Provides insight
* [vespa log](vespa_log.html) - Show the Vespa log
* [vespa prepare](vespa_prepare.html) - Prepare an application package for activation
* [vespa prod](vespa_prod.html) - Deploy an application package to production in Vespa Cloud
Expand Down
2 changes: 1 addition & 1 deletion en/reference/vespa-cli/vespa_document.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ $ vespa document src/test/resources/A-Head-Full-of-Dreams.json
### SEE ALSO

* [vespa](vespa.html) - The command-line tool for Vespa.ai
* [vespa document get](vespa_document_get.html) - Gets documents
* [vespa document get](vespa_document_get.html) - Gets one or more documents
* [vespa document put](vespa_document_put.html) - Writes a document to Vespa
* [vespa document remove](vespa_document_remove.html) - Removes a document from Vespa
* [vespa document update](vespa_document_update.html) - Modifies some fields of an existing document
Expand Down
8 changes: 5 additions & 3 deletions en/reference/vespa-cli/vespa_document_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@ render_with_liquid: false

## vespa document get

Gets documents
Gets one or more documents

```
vespa document get id [flags]
vespa document get id(s) [flags]
```

### Examples

```
$ vespa document get id:mynamespace:music::a-head-full-of-dreams...
$ vespa document get id:mynamespace:music::song-1
$ vespa document get id:mynamespace:music::song-1 id:mynamespace:music::song-2
```

### Options
Expand All @@ -23,6 +24,7 @@ $ vespa document get id:mynamespace:music::a-head-full-of-dreams...
--field-set string Fields to include when reading document
--header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times
-h, --help help for get
--ignore-missing Do not treat non-existent document as an error
-T, --timeout int Timeout for the document request in seconds (default 60)
-v, --verbose Print the equivalent curl command for the document operation
-w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0)
Expand Down
16 changes: 7 additions & 9 deletions en/reference/vespa-cli/vespa_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,13 @@ $ vespa query --header="X-First-Name: Joe" "yql=select * from music where album
### Options

```
--file string Read query parameters from the given JSON file and send a POST request, with overrides from arguments
--format string Output format. Must be 'human' (human-readable) or 'plain' (no formatting) (default "human")
--header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times
-h, --help help for query
--profile Enable profiling mode (Note: this feature is experimental)
--profile-file string Profiling result file (default "vespa_query_profile_result.json")
-T, --timeout int Timeout for the query in seconds (default 10)
-v, --verbose Print the equivalent curl command for the query
-w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0)
--file string Read query parameters from the given JSON file and send a POST request, with overrides from arguments
--format string Output format. Must be 'human' (human-readable) or 'plain' (no formatting) (default "human")
--header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times
-h, --help help for query
-T, --timeout int Timeout for the query in seconds (default 10)
-v, --verbose Print the equivalent curl command for the query
-w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0)
```

### Options inherited from parent commands
Expand Down

0 comments on commit f2375c3

Please sign in to comment.