honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/java-api/admin/indices/put-mapping.asciidoc

37 lines
1.4 KiB
Plaintext
Raw Normal View History

Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
[[java-admin-indices-put-mapping]]
[Docs] Fix Java Api index administration usage (#28260) The Java API documentation for index administration currenty is wrong because the PutMappingRequestBuilder#setSource(Object... source) an CreateIndexRequestBuilder#addMapping(String type, Object... source) methods delegate to methods that check that the input arguments are valid key/value pairs. This changes the docs so the java api code examples are included from documentation integration tests so we detect compile and runtime issues earlier. Closes #28131
2018-03-14 17:02:06 -04:00
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
==== Put Mapping
The PUT mapping API allows you to add a new type while creating an index:
[DOCS] fix put_mapping snippet (#28814) Add a java snippet to be run in an integration test in order to guarantee that the snippet is correct Closes #28778
2018-03-01 04:59:52 -05:00
["source","java",subs="attributes,callouts,macros"]
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
--------------------------------------------------
[DOCS] fix put_mapping snippet (#28814) Add a java snippet to be run in an integration test in order to guarantee that the snippet is correct Closes #28778
2018-03-01 04:59:52 -05:00
include-tagged::{client-tests}/IndicesDocumentationIT.java[index-with-mapping]
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
--------------------------------------------------
<1> <<java-admin-indices-create-index,Creates an index>> called `twitter`
<2> It also adds a `tweet` mapping type.
The PUT mapping API also allows to add a new type to an existing index:
[Docs] Fix Java Api index administration usage (#28260) The Java API documentation for index administration currenty is wrong because the PutMappingRequestBuilder#setSource(Object... source) an CreateIndexRequestBuilder#addMapping(String type, Object... source) methods delegate to methods that check that the input arguments are valid key/value pairs. This changes the docs so the java api code examples are included from documentation integration tests so we detect compile and runtime issues earlier. Closes #28131
2018-03-14 17:02:06 -04:00
["source","java",subs="attributes,callouts,macros"]
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
--------------------------------------------------
[Docs] Fix Java Api index administration usage (#28260) The Java API documentation for index administration currenty is wrong because the PutMappingRequestBuilder#setSource(Object... source) an CreateIndexRequestBuilder#addMapping(String type, Object... source) methods delegate to methods that check that the input arguments are valid key/value pairs. This changes the docs so the java api code examples are included from documentation integration tests so we detect compile and runtime issues earlier. Closes #28131
2018-03-14 17:02:06 -04:00
include-tagged::{client-tests}/IndicesDocumentationIT.java[putMapping-request-source]
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
--------------------------------------------------
<1> Puts a mapping on existing index called `twitter`
<2> Adds a `user` mapping type.
<3> This `user` has a predefined type
<4> type can be also provided within the source
You can use the same API to update an existing mapping:
[Docs] Fix Java Api index administration usage (#28260) The Java API documentation for index administration currenty is wrong because the PutMappingRequestBuilder#setSource(Object... source) an CreateIndexRequestBuilder#addMapping(String type, Object... source) methods delegate to methods that check that the input arguments are valid key/value pairs. This changes the docs so the java api code examples are included from documentation integration tests so we detect compile and runtime issues earlier. Closes #28131
2018-03-14 17:02:06 -04:00
["source","java",subs="attributes,callouts,macros"]
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
--------------------------------------------------
[Docs] Fix Java Api index administration usage (#28260) The Java API documentation for index administration currenty is wrong because the PutMappingRequestBuilder#setSource(Object... source) an CreateIndexRequestBuilder#addMapping(String type, Object... source) methods delegate to methods that check that the input arguments are valid key/value pairs. This changes the docs so the java api code examples are included from documentation integration tests so we detect compile and runtime issues earlier. Closes #28131
2018-03-14 17:02:06 -04:00
include-tagged::{client-tests}/IndicesDocumentationIT.java[putMapping-request-source-append]
Add documentation for Java API create index and put mapping Starting documentation about the admin client. * Create index with settings * put and update mapping. Closes #10816
2015-12-30 11:50:46 -05:00
--------------------------------------------------
<1> Puts a mapping on existing index called `twitter`
<2> Updates the `user` mapping type.
<3> This `user` has now a new field `user_name`
[Docs] Fix Java Api index administration usage (#28260) The Java API documentation for index administration currenty is wrong because the PutMappingRequestBuilder#setSource(Object... source) an CreateIndexRequestBuilder#addMapping(String type, Object... source) methods delegate to methods that check that the input arguments are valid key/value pairs. This changes the docs so the java api code examples are included from documentation integration tests so we detect compile and runtime issues earlier. Closes #28131
2018-03-14 17:02:06 -04:00
:base-dir!: