## Uses of Class
org.apache.ignite.configuration.CacheConfiguration

- Packages that use CacheConfiguration
  Package | Description
  --- | ---
  org.apache.ignite | Contains entry-point Ignite & HPC APIs.
  org.apache.ignite.cdc |
  org.apache.ignite.configuration | Contains configuration-related classes.
  org.apache.ignite.plugin | Contains plugins management API.
  org.apache.ignite.spi.systemview.view | Contains `SystemView` clases that exists in Ignite.

- - ### Uses of CacheConfiguration in org.apache.ignite

    Methods in org.apache.ignite with parameters of type CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `<K,​V> void` | Ignite.`addCacheConfiguration​(CacheConfiguration<K,​V> cacheCfg)` | Adds cache configuration template.
    `<K,​V> void` | IgniteSpringBean.`addCacheConfiguration​(CacheConfiguration<K,​V> cacheCfg)` | Adds cache configuration template.
    `<K,​V> IgniteCache<K,​V>` | Ignite.`createCache​(CacheConfiguration<K,​V> cacheCfg)` | Dynamically starts new cache with the given cache configuration.
    `<K,​V> IgniteCache<K,​V>` | Ignite.`createCache​(CacheConfiguration<K,​V> cacheCfg, NearCacheConfiguration<K,​V> nearCfg)` | Dynamically starts new cache with the given cache configuration.
    `<K,​V> IgniteCache<K,​V>` | IgniteSpringBean.`createCache​(CacheConfiguration<K,​V> cacheCfg)` | Dynamically starts new cache with the given cache configuration.
    `<K,​V> IgniteCache<K,​V>` | IgniteSpringBean.`createCache​(CacheConfiguration<K,​V> cacheCfg, NearCacheConfiguration<K,​V> nearCfg)` | Dynamically starts new cache with the given cache configuration.
    `<K,​V> IgniteCache<K,​V>` | Ignite.`getOrCreateCache​(CacheConfiguration<K,​V> cacheCfg)` | Gets existing cache with the given name or creates new one with the given configuration.
    `<K,​V> IgniteCache<K,​V>` | Ignite.`getOrCreateCache​(CacheConfiguration<K,​V> cacheCfg, NearCacheConfiguration<K,​V> nearCfg)` | Gets existing cache with the given cache configuration or creates one if it does not exist.
    `<K,​V> IgniteCache<K,​V>` | IgniteSpringBean.`getOrCreateCache​(CacheConfiguration<K,​V> cacheCfg)` | Gets existing cache with the given name or creates new one with the given configuration.
    `<K,​V> IgniteCache<K,​V>` | IgniteSpringBean.`getOrCreateCache​(CacheConfiguration<K,​V> cacheCfg, NearCacheConfiguration<K,​V> nearCfg)` | Gets existing cache with the given cache configuration or creates one if it does not exist.

    Method parameters in org.apache.ignite with type arguments of type CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `Collection<IgniteCache>` | Ignite.`createCaches​(Collection<CacheConfiguration> cacheCfgs)` | Dynamically starts new caches with the given cache configurations.
    `Collection<IgniteCache>` | IgniteSpringBean.`createCaches​(Collection<CacheConfiguration> cacheCfgs)` | Dynamically starts new caches with the given cache configurations.
    `Collection<IgniteCache>` | Ignite.`getOrCreateCaches​(Collection<CacheConfiguration> cacheCfgs)` | Gets existing caches with the given name or created one with the given configuration.
    `Collection<IgniteCache>` | IgniteSpringBean.`getOrCreateCaches​(Collection<CacheConfiguration> cacheCfgs)` | Gets existing caches with the given name or created one with the given configuration.

  - ### Uses of CacheConfiguration in org.apache.ignite.cdc

    Methods in org.apache.ignite.cdc that return CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CacheConfiguration<?,​?>` | CdcCacheEvent.`configuration()` | Note, `getQueryEntities()` value not changed on table schema change.

  - ### Uses of CacheConfiguration in org.apache.ignite.configuration

    Methods in org.apache.ignite.configuration that return CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CacheConfiguration<K,​V>` | CacheConfiguration.`clearQueryEntities()` | Clear query entities.
    `CacheConfiguration[]` | IgniteConfiguration.`getCacheConfiguration()` | Gets configuration (descriptors) for all caches.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setAffinity​(AffinityFunction aff)` | Sets affinity for cache keys.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setAffinityMapper​(AffinityKeyMapper affMapper)` | Sets custom affinity mapper.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setAtomicityMode​(CacheAtomicityMode atomicityMode)` | Sets cache atomicity mode.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setBackups​(int backups)` | Sets number of nodes used to back up single partition for `CacheMode.PARTITIONED` cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setCacheLoaderFactory​(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K,​V>> factory)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setCacheMode​(CacheMode cacheMode)` | Sets caching mode.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setCacheStoreFactory​(javax.cache.configuration.Factory<? extends CacheStore<? super K,​? super V>> storeFactory)` | Sets factory for persistent storage for cache data.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setCacheStoreSessionListenerFactories​(javax.cache.configuration.Factory<? extends CacheStoreSessionListener>... storeSesLsnrs)` | Cache store session listener factories.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setCacheWriterFactory​(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K,​? super V>> factory)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setCopyOnRead​(boolean cpOnRead)` | Sets copy on read flag.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setDataRegionName​(@Nullable String dataRegionName)` | Sets a name of `DataRegionConfiguration` for this cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setDefaultLockTimeout​(long dfltLockTimeout)` | Deprecated. Default lock timeout configuration property has no effect.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setDiskPageCompression​(DiskPageCompression diskPageCompression)` | Sets disk page compression algorithm.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setDiskPageCompressionLevel​(Integer diskPageCompressionLevel)` | Sets `algorithm` specific disk page compression level.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setEagerTtl​(boolean eagerTtl)` | Sets eager ttl flag.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setEncryptionEnabled​(boolean encryptionEnabled)` | Sets encrypted flag.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setEventsDisabled​(boolean evtsDisabled)` | Sets events disabled flag.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setEvictionFilter​(EvictionFilter<K,​V> evictFilter)` | Sets eviction filter.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setEvictionPolicy​(@Nullable EvictionPolicy evictPlc)` | Deprecated. Use `setEvictionPolicyFactory(Factory)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setEvictionPolicyFactory​(@Nullable javax.cache.configuration.Factory<? extends EvictionPolicy<? super K,​? super V>> evictPlcFactory)` | Sets cache eviction policy factory.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setExpiryPolicyFactory​(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> factory)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setGroupName​(String grpName)` | Sets the cache group name.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setIndexedTypes​(Class<?>... indexedTypes)` | Array of key and value type pairs to be indexed (thus array length must be always even).
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setInterceptor​(CacheInterceptor<K,​V> interceptor)` | Sets cache interceptor.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setInvalidate​(boolean invalidate)` | Sets invalidation flag for near cache entries in this transaction.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setKeyConfiguration​(CacheKeyConfiguration... cacheKeyCfg)` | Sets cache key configuration.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setLoadPreviousValue​(boolean loadPrevVal)` | Sets flag indicating whether value should be loaded from store if it is not in the cache for following cache operations: `IgniteCache.putIfAbsent(Object, Object)` `IgniteCache.replace(Object, Object)` `IgniteCache.replace(Object, Object, Object)` `IgniteCache.remove(Object, Object)` `IgniteCache.getAndPut(Object, Object)` `IgniteCache.getAndRemove(Object)` `IgniteCache.getAndReplace(Object, Object)` `IgniteCache.getAndPutIfAbsent(Object, Object)` When not set, default value is `DFLT_LOAD_PREV_VAL`.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setLongQueryWarningTimeout​(long longQryWarnTimeout)` | Deprecated. Use `IgniteConfiguration.setLongQueryWarningTimeout(long)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setManagementEnabled​(boolean enabled)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setMaxConcurrentAsyncOperations​(int maxConcurrentAsyncOps)` | Sets maximum number of concurrent asynchronous operations.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setMaxQueryIteratorsCount​(int maxQryIterCnt)` | Sets maximum number of query iterators that can be stored.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setMemoryPolicyName​(String memPlcName)` | Deprecated. Use `setDataRegionName(String)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setName​(String name)` | Sets cache name.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setNearConfiguration​(NearCacheConfiguration<K,​V> nearCfg)` | Sets the near cache configuration to use on all cache nodes.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setNodeFilter​(IgnitePredicate<ClusterNode> nodeFilter)` | Sets filter which determines on what nodes the cache should be started.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setOnheapCacheEnabled​(boolean onheapCache)` | Configures on-heap cache for the off-heap based page memory.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setPartitionLossPolicy​(PartitionLossPolicy partLossPlc)` | Sets partition loss policy.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setPlatformCacheConfiguration​(PlatformCacheConfiguration platformCfg)` | Sets platform cache configuration.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setPluginConfigurations​(CachePluginConfiguration... pluginCfgs)` | Sets cache plugin configurations.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setQueryDetailMetricsSize​(int qryDetailMetricsSz)` | Sets size of queries detail metrics that will be stored in memory for monitoring purposes.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setQueryEntities​(Collection<QueryEntity> qryEntities)` | Sets query entities configuration.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setQueryParallelism​(int qryParallelism)` | Sets query parallelism.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setReadFromBackup​(boolean readFromBackup)` | Sets read from backup flag.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setReadThrough​(boolean isReadThrough)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceBatchesPrefetchCount​(long rebalanceBatchesCnt)` | Deprecated. Use `IgniteConfiguration.setRebalanceBatchesPrefetchCount(long)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceBatchSize​(int rebalanceBatchSize)` | Deprecated. Use `IgniteConfiguration.setRebalanceBatchSize(int)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceDelay​(long rebalanceDelay)` | Deprecated. Use baseline topology feature instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceMode​(CacheRebalanceMode rebalanceMode)` | Sets cache rebalance mode.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceOrder​(int rebalanceOrder)` | Sets cache rebalance order.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceThreadPoolSize​(int rebalancePoolSize)` | Deprecated.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceThrottle​(long rebalanceThrottle)` | Deprecated. Use `IgniteConfiguration.setRebalanceThrottle(long)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setRebalanceTimeout​(long rebalanceTimeout)` | Deprecated. Use `IgniteConfiguration.setRebalanceTimeout(long)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setSqlEscapeAll​(boolean sqlEscapeAll)` | If `true` all the SQL table and field names will be escaped with double quotes like (`"tableName"."fieldsName"`).
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setSqlFunctionClasses​(Class<?>... cls)` | Sets classes with methods annotated by `QuerySqlFunction` to be used as user-defined functions from SQL queries.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setSqlIndexMaxInlineSize​(int sqlIdxMaxInlineSize)` | Sets maximum inline size for sql indexes.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setSqlOnheapCacheEnabled​(boolean sqlOnheapCache)` | Sets whether SQL on-heap cache is enabled.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setSqlOnheapCacheMaxSize​(int sqlOnheapCacheMaxSize)` | Sets maximum SQL on-heap cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setSqlSchema​(String sqlSchema)` | Sets sql schema to be used for current cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setStatisticsEnabled​(boolean enabled)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setStoreByValue​(boolean isStoreByVal)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setStoreConcurrentLoadAllThreshold​(int storeConcurrentLoadAllThreshold)` | Sets the concurrent load-all threshold used for cases when keys' values are being loaded from `CacheStore` in parallel.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setStoreKeepBinary​(boolean storeKeepBinary)` | Sets keep binary in store flag.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setTopologyValidator​(TopologyValidator topValidator)` | Sets topology validator.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setTransactionManagerLookupClassName​(String tmLookupClsName)` | Deprecated. Use `TransactionConfiguration.setTxManagerFactory(Factory)` instead.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setTypes​(Class<K> keyType, Class<V> valType)`
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteBehindBatchSize​(int writeBehindBatchSize)` | Sets maximum batch size for write-behind cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteBehindCoalescing​(boolean writeBehindCoalescing)` | Sets write coalescing flag for write-behind cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteBehindEnabled​(boolean writeBehindEnabled)` | Sets flag indicating whether write-behind is enabled.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteBehindFlushFrequency​(long writeBehindFlushFreq)` | Sets write-behind flush frequency.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteBehindFlushSize​(int writeBehindFlushSize)` | Sets write-behind flush size.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteBehindFlushThreadCount​(int writeBehindFlushThreadCnt)` | Sets flush thread count for write-behind cache.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteSynchronizationMode​(CacheWriteSynchronizationMode writeSync)` | Sets write synchronization mode.
    `CacheConfiguration<K,​V>` | CacheConfiguration.`setWriteThrough​(boolean isWriteThrough)`

    Methods in org.apache.ignite.configuration that return types with arguments of type CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `Map<String,​CacheConfiguration<?,​?>>` | CommunicationFailureContext.`startedCaches()` |

    Methods in org.apache.ignite.configuration with parameters of type CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `IgniteConfiguration` | IgniteConfiguration.`setCacheConfiguration​(CacheConfiguration... cacheCfg)` | Sets cache configurations.

  - ### Uses of CacheConfiguration in org.apache.ignite.plugin

    Methods in org.apache.ignite.plugin that return CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `CacheConfiguration` | CachePluginContext.`igniteCacheConfiguration()` |

    Methods in org.apache.ignite.plugin with parameters of type CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | CachePluginProvider.`validateRemote​(CacheConfiguration locCfg, CacheConfiguration rmtCfg, ClusterNode rmtNode)` | Checks that remote caches has configuration compatible with the local.

  - ### Uses of CacheConfiguration in org.apache.ignite.spi.systemview.view

    Methods in org.apache.ignite.spi.systemview.view with parameters of type CacheConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `static String` | CacheGroupView.`nodeFilter​(CacheConfiguration<?,​?> ccfg)` |