Skip to content

Commit 2b039af

Browse files
DOC-6186 doc DB quickstart desc/diff
1 parent b09aedd commit 2b039af

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

content/develop/get-started/document-database.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ You can alternatively use the [installation guides]({{< relref "/operate/oss_and
5353

5454
The first step is to connect to your Redis Open Source database. You can find further details about the connection options in this documentation site's [Tools section]({{< relref "/develop/tools" >}}). The following example shows how to connect to a Redis Open Source server that runs on localhost (`-h 127.0.0.1`) and listens on the default port (`-p 6379`):
5555

56-
{{< clients-example search_quickstart connect >}}
56+
{{< clients-example set="search_quickstart" step="connect" description="Foundational: Connect to a Redis server using redis-cli with host and port parameters" difficulty="beginner" >}}
5757
> redis-cli -h 127.0.0.1 -p 6379
5858
{{< /clients-example>}}
5959
@@ -70,7 +70,7 @@ As explained in the [in-memory data store]({{< relref "/develop/get-started/data
7070
The following example shows an [FT.CREATE]({{< relref "commands/ft.create" >}}) command that creates an index with some text fields, a numeric field (price), and a tag field (condition). The text fields have a weight of 1.0, meaning they have the same relevancy in the context of full-text searches. The field names follow the [JSONPath]({{< relref "/develop/data-types/json/path" >}}) notion. Each such index field maps to a property within the JSON document.
7171

7272

73-
{{< clients-example search_quickstart create_index >}}
73+
{{< clients-example set="search_quickstart" step="create_index" description="Foundational: Create an index on JSON documents using FT.CREATE with text, numeric, and tag fields" difficulty="beginner" >}}
7474
> FT.CREATE idx:bicycle ON JSON PREFIX 1 bicycle: SCORE 1.0 SCHEMA $.brand AS brand TEXT WEIGHT 1.0 $.model AS model TEXT WEIGHT 1.0 $.description AS description TEXT WEIGHT 1.0 $.price AS price NUMERIC $.condition AS condition TAG SEPARATOR ,
7575
OK
7676
{{< / clients-example >}}
@@ -81,7 +81,7 @@ Any pre-existing JSON documents with a key prefix `bicycle:` are automatically a
8181

8282
The example below shows you how to use the [JSON.SET]({{< relref "commands/json.set" >}}) command to create new JSON documents:
8383

84-
{{< clients-example search_quickstart add_documents "" 2 >}}
84+
{{< clients-example set="search_quickstart" step="add_documents" description="Foundational: Add JSON documents to Redis using JSON.SET" difficulty="beginner" max_lines="2" >}}
8585
> JSON.SET "bicycle:0" "." "{\"brand\": \"Velorim\", \"model\": \"Jigger\", \"price\": 270, \"description\": \"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids\\u2019 pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.\", \"condition\": \"new\"}"
8686
OK
8787
> JSON.SET "bicycle:1" "." "{\"brand\": \"Bicyk\", \"model\": \"Hillcraft\", \"price\": 1200, \"description\": \"Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\\\" wheel bike is just too clumsy coming off a 24\\\" bike. The Hillcraft 26 is just the solution they need!\", \"condition\": \"used\"}"
@@ -110,7 +110,7 @@ OK
110110

111111
You can retrieve all indexed documents using the [FT.SEARCH]({{< relref "commands/ft.search" >}}) command. Note the `LIMIT` clause below, which allows result pagination.
112112

113-
{{< clients-example search_quickstart wildcard_query "" 10 >}}
113+
{{< clients-example set="search_quickstart" step="wildcard_query" description="Foundational: Retrieve all indexed documents using FT.SEARCH with wildcard query" difficulty="beginner" max_lines="10" >}}
114114
> FT.SEARCH "idx:bicycle" "*" LIMIT 0 10
115115
1) (integer) 10
116116
2) "bicycle:1"
@@ -149,7 +149,7 @@ You can retrieve all indexed documents using the [FT.SEARCH]({{< relref "command
149149

150150
The following command shows a simple single-term query for finding all bicycles with a specific model:
151151

152-
{{< clients-example search_quickstart query_single_term >}}
152+
{{< clients-example set="search_quickstart" step="query_single_term" description="Foundational: Perform a single-term full-text query using FT.SEARCH to find documents matching a specific field value" difficulty="beginner" >}}
153153
> FT.SEARCH "idx:bicycle" "@model:Jigger" LIMIT 0 10
154154
1) (integer) 1
155155
2) "bicycle:0"
@@ -161,7 +161,7 @@ The following command shows a simple single-term query for finding all bicycles
161161

162162
Below is a command to perform an exact match query that finds all bicycles with the brand name `Noka Bikes`. You must use double quotes around the search term when constructing an exact match query on a text field.
163163

164-
{{< clients-example search_quickstart query_exact_matching >}}
164+
{{< clients-example set="search_quickstart" step="query_exact_matching" description="Foundational: Perform an exact match query using FT.SEARCH with double quotes to find documents with precise field values" difficulty="beginner" >}}
165165
> FT.SEARCH "idx:bicycle" "@brand:\"Noka Bikes\"" LIMIT 0 10
166166
1) (integer) 1
167167
2) "bicycle:4"

0 commit comments

Comments
 (0)