Added new docs examples (#1101)

* Added new docs examples

* Updated enabled files list
This commit is contained in:
Tomas Della Vedova
2020-03-04 09:20:27 +01:00
committed by GitHub
parent 7b7c9130f3
commit 508aa362e6
50 changed files with 1035 additions and 1 deletions

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.update({
index: 'test',
id: '1',
body: {
doc: {
name: 'new_name'
},
detect_noop: false
}
})
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.search({
body: {
query: {
match_all: {}
}
}
})
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.update({
index: 'test',
id: '1',
body: {
script: {
source: 'ctx._source.counter += params.count',
lang: 'painless',
params: {
count: 4
}
},
upsert: {
counter: 1
}
}
})
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.reindex({
body: {
source: {
index: 'twitter'
},
dest: {
index: 'new_twitter'
}
}
})
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.reindex({
body: {
source: {
index: 'test'
},
dest: {
index: 'test2'
},
script: {
source: 'ctx._source.tag = ctx._source.remove("flag")'
}
}
})
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.index({
index: 'test',
id: '1',
refresh: true,
body: {
text: 'words words',
flag: 'foo'
}
})
console.log(response)
----

View File

@ -0,0 +1,38 @@
// 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.reindex({
body: {
source: {
index: 'twitter',
slice: {
id: 0,
max: 2
}
},
dest: {
index: 'new_twitter'
}
}
})
console.log(response0)
const response1 = await client.reindex({
body: {
source: {
index: 'twitter',
slice: {
id: 1,
max: 2
}
},
dest: {
index: 'new_twitter'
}
}
})
console.log(response1)
----

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.indices.putTemplate({
name: 'template_1',
body: {
index_patterns: [
'te*'
],
settings: {
number_of_shards: 1
},
aliases: {
alias1: {},
alias2: {
filter: {
term: {
user: 'kimchy'
}
},
routing: 'kimchy'
},
'{index}-alias': {}
}
}
})
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.reindex({
body: {
max_docs: 10,
source: {
index: 'twitter',
query: {
function_score: {
random_score: {},
min_score: 0.9
}
}
},
dest: {
index: 'random_twitter'
}
}
})
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: {
full_text: {
type: 'text'
}
}
}
}
})
console.log(response)
----

View File

@ -0,0 +1,28 @@
// 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.reindex({
body: {
source: {
remote: {
host: 'http://otherhost:9200',
username: 'user',
password: 'pass'
},
index: 'source',
query: {
match: {
test: 'data'
}
}
},
dest: {
index: 'dest'
}
}
})
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: 'test',
id: '1',
body: {
counter: 1,
tags: [
'red'
]
}
})
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.update({
index: 'test',
id: '1',
body: {
doc: {
name: 'new_name'
}
}
})
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 response0 = await client.indices.refresh()
console.log(response0)
const response1 = await client.search({
index: 'new_twitter',
size: '0',
filter_path: 'hits.total'
})
console.log(response1)
----

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 response0 = await client.get({
index: 'metricbeat-2016.05.30-1',
id: '1'
})
console.log(response0)
const response1 = await client.get({
index: 'metricbeat-2016.05.31-1',
id: '1'
})
console.log(response1)
----

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.reindex({
body: {
source: {
index: 'source',
size: 100
},
dest: {
index: 'dest',
routing: '=cat'
}
}
})
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.indices.getTemplate({
name: 'template_1',
filter_path: '*.version'
})
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.update({
index: 'test',
id: '1',
body: {
script: {
source: 'ctx._source.tags.add(params.tag)',
lang: 'painless',
params: {
tag: '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.reindex({
body: {
max_docs: 1,
source: {
index: 'twitter'
},
dest: {
index: 'new_twitter'
}
}
})
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.update({
index: 'test',
id: '1',
body: {
script: "ctx._source.remove('new_field')"
}
})
console.log(response)
----

View File

@ -0,0 +1,27 @@
// 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.reindex({
body: {
source: {
remote: {
host: 'http://otherhost:9200'
},
index: 'source',
size: 10,
query: {
match: {
test: 'data'
}
}
},
dest: {
index: 'dest'
}
}
})
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.reindexRethrottle({
task_id: 'r1A2WoRbTwKZ516z6NEs5A:36619',
requests_per_second: '-1'
})
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.reindex({
body: {
source: {
index: [
'twitter',
'blog'
]
},
dest: {
index: 'all_together'
}
}
})
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: {
match_all: {
boost: 1.2
}
}
}
})
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.reindex({
body: {
source: {
index: 'twitter',
query: {
term: {
user: 'kimchy'
}
}
},
dest: {
index: 'new_twitter'
}
}
})
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.reindex({
body: {
source: {
index: 'source',
query: {
match: {
company: 'cat'
}
}
},
dest: {
index: 'dest',
routing: '=cat'
}
}
})
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.update({
index: 'test',
id: '1',
body: {
doc: {
name: 'new_name'
},
doc_as_upsert: true
}
})
console.log(response)
----

View File

@ -0,0 +1,28 @@
// 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.reindex({
body: {
source: {
remote: {
host: 'http://otherhost:9200',
socket_timeout: '1m',
connect_timeout: '10s'
},
index: 'source',
query: {
match: {
test: 'data'
}
}
},
dest: {
index: 'dest'
}
}
})
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.search({
body: {
query: {
match_none: {}
}
}
})
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.reindex({
body: {
source: {
index: 'twitter'
},
dest: {
index: 'new_twitter',
version_type: 'external'
},
script: {
source: "if (ctx._source.foo == 'bar') {ctx._version++; ctx._source.remove('foo')}",
lang: 'painless'
}
}
})
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.putTemplate({
name: 'template_1',
body: {
index_patterns: [
'*'
],
order: 0,
settings: {
number_of_shards: 1
},
version: 123
}
})
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.update({
index: 'test',
id: '1',
body: {
script: {
source: 'ctx._source.counter += params.count',
lang: 'painless',
params: {
count: 4
}
}
}
})
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.reindex({
body: {
source: {
index: 'metricbeat-*'
},
dest: {
index: 'metricbeat'
},
script: {
lang: 'painless',
source: "ctx._index = 'metricbeat-' + (ctx._index.substring('metricbeat-'.length(), ctx._index.length())) + '-1'"
}
}
})
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.update({
index: 'test',
id: '1',
body: {
script: {
source: "if (ctx._source.tags.contains(params.tag)) { ctx.op = 'delete' } else { ctx.op = 'none' }",
lang: 'painless',
params: {
tag: 'green'
}
}
}
})
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 response0 = await client.index({
index: 'metricbeat-2016.05.30',
id: '1',
refresh: true,
body: {
'system.cpu.idle.pct': 0.908
}
})
console.log(response0)
const response1 = await client.index({
index: 'metricbeat-2016.05.31',
id: '1',
refresh: true,
body: {
'system.cpu.idle.pct': 0.105
}
})
console.log(response1)
----

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.search({
index: 'my_index',
pretty: true,
body: {
query: {
match: {
full_text: 'Quick Brown Foxes!'
}
}
}
})
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.update({
index: 'test',
id: '1',
body: {
script: {
source: 'if (ctx._source.tags.contains(params.tag)) { ctx._source.tags.remove(ctx._source.tags.indexOf(params.tag)) }',
lang: 'painless',
params: {
tag: '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.reindex({
body: {
source: {
index: 'source'
},
dest: {
index: 'dest',
pipeline: 'some_ingest_pipeline'
}
}
})
console.log(response)
----

View File

@ -0,0 +1,44 @@
// 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.putTemplate({
name: 'template_1',
body: {
index_patterns: [
'*'
],
order: 0,
settings: {
number_of_shards: 1
},
mappings: {
_source: {
enabled: false
}
}
}
})
console.log(response0)
const response1 = await client.indices.putTemplate({
name: 'template_2',
body: {
index_patterns: [
'te*'
],
order: 1,
settings: {
number_of_shards: 1
},
mappings: {
_source: {
enabled: true
}
}
}
})
console.log(response1)
----

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.reindex({
slices: '5',
refresh: true,
body: {
source: {
index: 'twitter'
},
dest: {
index: 'new_twitter'
}
}
})
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.search({
index: 'my_index',
pretty: true,
body: {
query: {
term: {
full_text: 'Quick Brown Foxes!'
}
}
}
})
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.get({
index: 'test2',
id: '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({
body: {
query: {
term: {
user: {
value: 'Kimchy',
boost: 1
}
}
}
}
})
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: '1',
body: {
full_text: 'Quick Brown Foxes!'
}
})
console.log(response)
----

View File

@ -0,0 +1,13 @@
// 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: 'new_twitter',
size: '0',
filter_path: 'hits.total'
})
console.log(response)
----

View File

@ -0,0 +1,34 @@
// 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.putTemplate({
name: 'template_1',
body: {
index_patterns: [
'te*',
'bar*'
],
settings: {
number_of_shards: 1
},
mappings: {
_source: {
enabled: false
},
properties: {
host_name: {
type: 'keyword'
},
created_at: {
type: 'date',
format: 'EEE MMM dd HH:mm:ss Z yyyy'
}
}
}
}
})
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.reindex({
body: {
source: {
index: 'twitter',
_source: [
'user',
'_doc'
]
},
dest: {
index: 'new_twitter'
}
}
})
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.update({
index: 'test',
id: '1',
body: {
script: "ctx._source.new_field = 'value_of_new_field'"
}
})
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.update({
index: 'sessions',
id: 'dh3sgudg8gsrgl',
body: {
scripted_upsert: true,
script: {
id: 'my_web_session_summariser',
params: {
pageViewEvent: {
url: 'foo.com/bar',
response: 404,
time: '2014-01-01 12:32'
}
}
},
upsert: {}
}
})
console.log(response)
----

View File

@ -49,7 +49,12 @@ const enabledFiles = [
'query-dsl/multi-match-query.asciidoc',
'docs/bulk.asciidoc',
'indices/delete-index.asciidoc',
'indices/put-mapping.asciidoc'
'indices/put-mapping.asciidoc',
'query-dsl/match-all-query.asciidoc',
'query-dsl/term-query.asciidoc',
'docs/update.asciidoc',
'docs/reindex.asciidoc',
'indices/templates.asciidoc'
]
function generate () {