Skip to content

Commit

Permalink
IGNITE-19647 Cleared up Cache Template docs (apache#10853)
Browse files Browse the repository at this point in the history
  • Loading branch information
IgGusev authored Jul 27, 2023
1 parent 83c75d8 commit dc011c7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/_docs/configuring-caches/configuration-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ tab:C++[unsupported]
== Cache Templates
A cache template is an instance of `CacheConfiguration` that can be registered in the cluster and used later as a basis for creating new caches or SQL tables. A cache or table created from a template inherits all the properties of the template.

Templates are useful when creating a table using the link:sql-reference/ddl#create-table[CREATE TABLE] command, because the command does not support all available cache parameters.
A cache template is an instance of `CacheConfiguration` that can be registered in the cluster and used later as a basis for creating new caches or SQL tables. A cache or table created from a template inherits all the properties of the template.

NOTE: Currently, templates are supported for the CREATE TABLE and REST commands.
Templates can be used in many contexts: on servers, clients (thin and thick), in SQL (e.g., CREATE TABLE), in commands such as `createCache` and `getOrCreateCache`, as well as in the REST API calls. For example, thin clients and SQL do not support some cache configuration properties, and cache templates can be used to work around this limitation.

To create a template, define a cache configuration and add it to the `Ignite` instance, as shown below. If you want do define a cache template in the XML configuration file, you must add an asterisk to the template's name. This is required to indicate that the configuration is a template and not an actual cache.

Expand Down

0 comments on commit dc011c7

Please sign in to comment.