Skip to content

Commit 5c53d07

Browse files
simon-dewtech-comm-team-couchbase
simon-dew
and
tech-comm-team-couchbase
committed
AV-102698: Add passthroughs to Data API documentation (#172)
* Add query examples * Update Base URLs and credentials * Add additional property name * Minor nits * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
1 parent c49d2a2 commit 5c53d07

18 files changed

Lines changed: 293 additions & 11 deletions

‎docs/modules/n1ql-rest-query/examples/exformdata.sh‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
curl -v $BASEURL/_p/query/query/service \
2+
-d 'statement=SELECT name FROM `travel-sample`.inventory.hotel LIMIT 1' \
3+
-u $USER:$PASSWORD

‎docs/modules/n1ql-rest-query/examples/exn1qlerror.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"requestID": "27087759-07af-431d-a3d7-29080f870e56",
3+
"errors": [
4+
{
5+
"code": 3000,
6+
"msg": "syntax error - line 1, column 7, near 'SLECT', at: name"
7+
}
8+
],
9+
"status": "fatal",
10+
"metrics": {
11+
"elapsedTime": "1.478631ms",
12+
"executionTime": "1.393274ms",
13+
"resultCount": 0,
14+
"resultSize": 0,
15+
"serviceLoad": 12,
16+
"errorCount": 1
17+
}
18+
}

‎docs/modules/n1ql-rest-query/examples/exnamed.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"requestID": "81aceab8-7f7a-4d00-b741-00385740329a",
3+
"signature": {
4+
"airline": "json"
5+
},
6+
"results": [
7+
{
8+
"airline": "B6"
9+
},
10+
{
11+
"airline": "EK"
12+
},
13+
{
14+
"airline": "SV"
15+
}
16+
],
17+
"status": "success",
18+
"metrics": {
19+
"elapsedTime": "72.886709ms",
20+
"executionTime": "72.765333ms",
21+
"resultCount": 3,
22+
"resultSize": 48,
23+
"serviceLoad": 12
24+
}
25+
}

‎docs/modules/n1ql-rest-query/examples/exnamed.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
curl -v $BASEURL/_p/query/query/service \
2+
-d 'statement=SELECT airline FROM `travel-sample`.inventory.route
3+
WHERE sourceairport = $aval AND distance > $dval
4+
& $aval="LAX" & $dval=13000' \
5+
-u $USER:$PASSWORD

‎docs/modules/n1ql-rest-query/examples/exnotfound.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"requestID": "d30b805f-6c1e-44ec-9aec-35ff711a6e88",
3+
"errors": [
4+
{
5+
"code": 12003,
6+
"msg": "Keyspace not found in CB datastore: default:travel-sample.inventory.motel"
7+
}
8+
],
9+
"status": "fatal",
10+
"metrics": {
11+
"elapsedTime": "3.096786ms",
12+
"executionTime": "2.468282ms",
13+
"resultCount": 0,
14+
"resultSize": 0,
15+
"serviceLoad": 12,
16+
"errorCount": 1
17+
}
18+
}

‎docs/modules/n1ql-rest-query/examples/exnumbered.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"requestID": "6e242629-ebf5-4a58-8db4-62d94974519f",
3+
"signature": {
4+
"airline": "json"
5+
},
6+
"results": [
7+
{
8+
"airline": "B6"
9+
},
10+
{
11+
"airline": "EK"
12+
},
13+
{
14+
"airline": "SV"
15+
}
16+
],
17+
"status": "success",
18+
"metrics": {
19+
"elapsedTime": "86.962678ms",
20+
"executionTime": "84.35715ms",
21+
"resultCount": 3,
22+
"resultSize": 48,
23+
"serviceLoad": 12
24+
}
25+
}

‎docs/modules/n1ql-rest-query/examples/exnumbered.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
curl -v $BASEURL/_p/query/query/service \
2+
-d 'statement=SELECT airline FROM `travel-sample`.inventory.route
3+
WHERE sourceairport = $1 AND distance > $2
4+
& args=["LAX", 13000]' \
5+
-u $USER:$PASSWORD

‎docs/modules/n1ql-rest-query/examples/expositional.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"requestID": "6d77dc41-3cab-4e00-9c54-f60fcc2e0fab",
3+
"signature": {
4+
"airline": "json"
5+
},
6+
"results": [
7+
{
8+
"airline": "B6"
9+
},
10+
{
11+
"airline": "EK"
12+
},
13+
{
14+
"airline": "SV"
15+
}
16+
],
17+
"status": "success",
18+
"metrics": {
19+
"elapsedTime": "86.226474ms",
20+
"executionTime": "86.072996ms",
21+
"resultCount": 3,
22+
"resultSize": 48,
23+
"serviceLoad": 12
24+
}
25+
}

‎docs/modules/n1ql-rest-query/examples/expositional.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
curl -v $BASEURL/_p/query/query/service \
2+
-d 'statement=SELECT airline FROM `travel-sample`.inventory.route
3+
WHERE sourceairport = ? AND distance > ?
4+
& args=["LAX", 13000]' \
5+
-u $USER:$PASSWORD

‎docs/modules/n1ql-rest-query/examples/exreadonly.sh‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
curl -v $BASEURL/_p/query/query/service?statement=SELECT%20name%20FROM%20%60travel-sample%60.inventory.hotel%20LIMIT%201%3B \
2+
-u $USER:$PASSWORD

0 commit comments

Comments
 (0)