Added new docs examples (#1149)

* Updated enabled files list

* Added new docs examples
This commit is contained in:
Tomas Della Vedova
2020-04-10 12:20:25 +02:00
committed by GitHub
parent 7717799ca6
commit 0e659031e3
47 changed files with 1193 additions and 1 deletions

View File

@ -0,0 +1,30 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
term: {
user: 'kimchy'
}
},
sort: {
_script: {
type: 'number',
script: {
lang: 'painless',
source: "doc['field_name'].value * params.factor",
params: {
factor: 1.1
}
},
order: 'asc'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
terms: {
user: [
'kimchy',
'elasticsearch'
],
boost: 1
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,22 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'twitter',
size: '0',
filter_path: 'hits.total',
body: {
query: {
range: {
likes: {
lt: 10
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,29 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
_geo_distance: {
'pin.location': [
-70,
40
],
order: 'asc',
unit: 'km'
}
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,11 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.tasks.cancel({
task_id: 'r1A2WoRbTwKZ516z6NEs5A:36619'
})
console.log(response)
----

View File

@ -0,0 +1,42 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.deleteByQuery({
index: 'twitter',
body: {
slice: {
id: 0,
max: 2
},
query: {
range: {
likes: {
lt: 10
}
}
}
}
})
console.log(response0)
const response1 = await client.deleteByQuery({
index: 'twitter',
body: {
slice: {
id: 1,
max: 2
},
query: {
range: {
likes: {
lt: 10
}
}
}
}
})
console.log(response1)
----

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.tasks.list({
detailed: 'true',
actions: '*/delete/byquery'
})
console.log(response)
----

View File

@ -0,0 +1,64 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
nested: {
path: 'parent',
query: {
bool: {
must: {
range: {
'parent.age': {
gte: 21
}
}
},
filter: {
nested: {
path: 'parent.child',
query: {
match: {
'parent.child.name': 'matt'
}
}
}
}
}
}
}
},
sort: [
{
'parent.child.age': {
mode: 'min',
order: 'asc',
nested: {
path: 'parent',
filter: {
range: {
'parent.age': {
gte: 21
}
}
},
nested: {
path: 'parent.child',
filter: {
match: {
'parent.child.name': 'matt'
}
}
}
}
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'index_long,index_double',
body: {
sort: [
{
field: {
numeric_type: 'double'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,17 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
exists: {
field: 'user'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,25 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.indices.refresh()
console.log(response0)
const response1 = await client.search({
index: 'twitter',
size: '0',
filter_path: 'hits.total',
body: {
query: {
range: {
likes: {
lt: 10
}
}
}
}
})
console.log(response1)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
bool: {
must_not: {
exists: {
field: 'user'
}
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,12 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQueryRethrottle({
task_id: 'r1A2WoRbTwKZ516z6NEs5A:36619',
requests_per_second: '-1'
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'index_long,index_double',
body: {
sort: [
{
field: {
numeric_type: 'date_nanos'
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'index_long',
body: {
mappings: {
properties: {
field: {
type: 'date_nanos'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,35 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
_geo_distance: {
'pin.location': [
[
-70,
40
],
[
-71,
42
]
],
order: 'asc',
unit: 'km'
}
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
date: {
type: 'date',
format: 'yyyy-MM-dd'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
price: {
unmapped_type: 'long'
}
}
],
query: {
term: {
product: 'chocolate'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,25 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.index({
index: 'my_index',
id: '1',
body: {
group: 'fans',
user: [
{
first: 'John',
last: 'Smith'
},
{
first: 'Alice',
last: 'White'
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,15 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.index({
index: 'my_index',
id: '2',
body: {
color: 'blue'
}
})
console.log(response)
----

View File

@ -0,0 +1,29 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
_geo_distance: {
'pin.location': {
lat: 40,
lon: -70
},
order: 'asc',
unit: 'km'
}
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
color: {
type: 'keyword'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,26 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
_geo_distance: {
'pin.location': 'drm3btev3e86',
order: 'asc',
unit: 'km'
}
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,22 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQuery({
index: 'twitter',
refresh: true,
slices: '5',
body: {
query: {
range: {
likes: {
lt: 10
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'index_double',
body: {
mappings: {
properties: {
field: {
type: 'double'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,33 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'my_index',
body: {
sort: [
{
post_date: {
order: 'asc'
}
},
'user',
{
name: 'desc'
},
{
age: 'desc'
},
'_score'
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,29 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'my_index',
body: {
query: {
bool: {
must: [
{
match: {
'user.first': 'Alice'
}
},
{
match: {
'user.last': 'Smith'
}
}
]
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,102 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
user: {
type: 'nested'
}
}
}
}
})
console.log(response0)
const response1 = await client.index({
index: 'my_index',
id: '1',
body: {
group: 'fans',
user: [
{
first: 'John',
last: 'Smith'
},
{
first: 'Alice',
last: 'White'
}
]
}
})
console.log(response1)
const response2 = await client.search({
index: 'my_index',
body: {
query: {
nested: {
path: 'user',
query: {
bool: {
must: [
{
match: {
'user.first': 'Alice'
}
},
{
match: {
'user.last': 'Smith'
}
}
]
}
}
}
}
}
})
console.log(response2)
const response3 = await client.search({
index: 'my_index',
body: {
query: {
nested: {
path: 'user',
query: {
bool: {
must: [
{
match: {
'user.first': 'Alice'
}
},
{
match: {
'user.last': 'White'
}
}
]
}
},
inner_hits: {
highlight: {
fields: {
'user.first': {}
}
}
}
}
}
}
})
console.log(response3)
----

View File

@ -0,0 +1,39 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response0 = await client.index({
index: 'my_index',
id: '1',
refresh: true,
body: {
product: 'chocolate',
price: [
20,
4
]
}
})
console.log(response0)
const response1 = await client.search({
body: {
query: {
term: {
product: 'chocolate'
}
},
sort: [
{
price: {
order: 'asc',
mode: 'avg'
}
}
]
}
})
console.log(response1)
----

View File

@ -0,0 +1,11 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.tasks.get({
task_id: 'r1A2WoRbTwKZ516z6NEs5A:36619'
})
console.log(response)
----

View File

@ -0,0 +1,16 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQuery({
index: 'twitter,blog',
body: {
query: {
match_all: {}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQuery({
index: 'twitter',
routing: '1',
body: {
query: {
range: {
age: {
gte: 10
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,32 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
_geo_distance: {
'pin.location': [
-70,
40
],
order: 'asc',
unit: 'km',
mode: 'min',
distance_type: 'arc',
ignore_unmapped: true
}
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,29 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'my_index',
body: {
mappings: {
properties: {
post_date: {
type: 'date'
},
user: {
type: 'keyword'
},
name: {
type: 'keyword'
},
age: {
type: 'integer'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,23 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
index: 'my_index',
pretty: true,
body: {
query: {
terms: {
color: {
index: 'my_index',
id: '2',
path: 'color'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,18 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.index({
index: 'my_index',
id: '1',
body: {
color: [
'blue',
'green'
]
}
})
console.log(response)
----

View File

@ -0,0 +1,21 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
wildcard: {
user: {
value: 'ki*y',
boost: 1,
rewrite: 'constant_score'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,26 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
_geo_distance: {
'pin.location': '40,-70',
order: 'asc',
unit: 'km'
}
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,33 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
query: {
term: {
product: 'chocolate'
}
},
sort: [
{
'offer.price': {
mode: 'avg',
order: 'asc',
nested: {
path: 'offer',
filter: {
term: {
'offer.color': 'blue'
}
}
}
}
}
]
}
})
console.log(response)
----

View File

@ -0,0 +1,19 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQuery({
index: 'twitter',
scroll_size: '5000',
body: {
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,17 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQuery({
index: 'twitter',
conflicts: 'proceed',
body: {
query: {
match_all: {}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,31 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
track_scores: true,
sort: [
{
post_date: {
order: 'desc'
}
},
{
name: 'desc'
},
{
age: 'desc'
}
],
query: {
term: {
user: 'kimchy'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,18 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.deleteByQuery({
index: 'twitter',
body: {
query: {
match: {
message: 'some message'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,24 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.search({
body: {
sort: [
{
price: {
missing: '_last'
}
}
],
query: {
term: {
product: 'chocolate'
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'index_double',
body: {
mappings: {
properties: {
field: {
type: 'date'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,20 @@
// This file is autogenerated, DO NOT EDIT
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
[source, js]
----
const response = await client.indices.create({
index: 'index_long',
body: {
mappings: {
properties: {
field: {
type: 'long'
}
}
}
}
})
console.log(response)
----

View File

@ -54,7 +54,14 @@ const enabledFiles = [
'query-dsl/term-query.asciidoc',
'docs/update.asciidoc',
'docs/reindex.asciidoc',
'indices/templates.asciidoc'
'indices/templates.asciidoc',
'query-dsl/exists-query.asciidoc',
'query-dsl/terms-query.asciidoc',
'query-dsl/wildcard-query.asciidoc',
'mapping/types/nested.asciidoc',
'mapping/params/format.asciidoc',
'docs/delete-by-query.asciidoc',
'search/request/sort.asciidoc'
]
function generate () {