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

42 lines
1.7 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
Fix put mappings java API documentation (#31955) The current docs of the put-mapping Java API is currently broken. It its current form, it creates an index and uses the whole mapping definition given as a JSON string as the type name. Since we didn't check the index created in the IndicesDocumentationIT so far this went unnoticed. This change adds test to catch this error to the documentation test, changes the documentation so it works correctly now and adds an input validation to PutMappingRequest#buildFromSimplifiedDef() which was used internally to reject calls where no mapping definition is given. Closes #31906
2018-07-17 03:09:03 -04:00
You can add mappings for a new type at index creation time:
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
["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`
Fix put mappings java API documentation (#31955) The current docs of the put-mapping Java API is currently broken. It its current form, it creates an index and uses the whole mapping definition given as a JSON string as the type name. Since we didn't check the index created in the IndicesDocumentationIT so far this went unnoticed. This change adds test to catch this error to the documentation test, changes the documentation so it works correctly now and adds an input validation to PutMappingRequest#buildFromSimplifiedDef() which was used internally to reject calls where no mapping definition is given. Closes #31906
2018-07-17 03:09:03 -04:00
<2> Add a `tweet` type with a field called `message` that has the datatype `text`.
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
Fix put mappings java API documentation (#31955) The current docs of the put-mapping Java API is currently broken. It its current form, it creates an index and uses the whole mapping definition given as a JSON string as the type name. Since we didn't check the index created in the IndicesDocumentationIT so far this went unnoticed. This change adds test to catch this error to the documentation test, changes the documentation so it works correctly now and adds an input validation to PutMappingRequest#buildFromSimplifiedDef() which was used internally to reject calls where no mapping definition is given. Closes #31906
2018-07-17 03:09:03 -04:00
There are several variants of the above `addMapping` method, some taking an
`XContentBuilder` or a `Map` with the mapping definition as arguments. Make sure
to check the javadocs to pick the simplest one for your use case.
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
Fix put mappings java API documentation (#31955) The current docs of the put-mapping Java API is currently broken. It its current form, it creates an index and uses the whole mapping definition given as a JSON string as the type name. Since we didn't check the index created in the IndicesDocumentationIT so far this went unnoticed. This change adds test to catch this error to the documentation test, changes the documentation so it works correctly now and adds an input validation to PutMappingRequest#buildFromSimplifiedDef() which was used internally to reject calls where no mapping definition is given. Closes #31906
2018-07-17 03:09:03 -04:00
The PUT mapping API also allows to specify the mapping of a type after index
creation. In this case you can provide the mapping as a String similar to the
Rest API syntax:
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
["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!: