org.apache.ignite.internal.processors.cache.query

Interface GridCacheSqlMetadata

All Superinterfaces:

Externalizable, Serializable

All Known Implementing Classes:

GridCacheQueryManager.CacheSqlMetadata, GridCacheQuerySqlMetadataV2

public interface GridCacheSqlMetadata
extends Externalizable

Metadata for Ignite cache.

Metadata describes objects stored in the cache and can be used to gather information about what can be queried using Ignite cache queries feature.

Method Summary

Modifier and Type	Method and Description
String	cacheName() Cache name.
Map<String,Map<String,String>>	fields()
@Nullable Map<String,String>	fields(String type) Gets fields and their class names for provided type.
Map<String,Collection<GridCacheSqlIndexMetadata>>	indexes()
Collection<GridCacheSqlIndexMetadata>	indexes(String type) Gets descriptors of indexes created for provided type.
@Nullable String	keyClass(String type) Gets key class name for provided type.
Map<String,String>	keyClasses()
Collection<String>	notNullFields(String type) Gets not null fields.
Collection<String>	types() Gets the collection of types stored in cache.
Map<String,String>	valClasses()
@Nullable String	valueClass(String type) Gets value class name for provided type.

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

cacheName

String cacheName()

Cache name.

Returns:

Cache name.

types

Collection<String> types()

Gets the collection of types stored in cache.

By default, type name is equal to simple class name of stored object, but it can depend on implementation of IndexingSpi.

Returns:

Collection of available types.

keyClass

@Nullable
@Nullable String keyClass(String type)

Gets key class name for provided type.

Use types() method to get available types.

Parameters:

type - Type name.

Returns:

Key class name or null if type name is unknown.

valueClass

@Nullable
@Nullable String valueClass(String type)

Gets value class name for provided type.

Use types() method to get available types.

Parameters:

type - Type name.

Returns:

Value class name or null if type name is unknown.

fields

@Nullable
@Nullable Map<String,String> fields(String type)

Gets fields and their class names for provided type.

Parameters:

type - Type name.

Returns:

Fields map or null if type name is unknown.

notNullFields

Collection<String> notNullFields(String type)

Gets not null fields.

Parameters:

type - Type name.

Returns:

Not null fields collection map or null if type name is unknown.

keyClasses

Map<String,String> keyClasses()

Returns:

Key classes.

valClasses

Map<String,String> valClasses()

Returns:

Value classes.

fields

Map<String,Map<String,String>> fields()

Returns:

Fields.

indexes

Map<String,Collection<GridCacheSqlIndexMetadata>> indexes()

Returns:

Indexes.

indexes

Collection<GridCacheSqlIndexMetadata> indexes(String type)

Gets descriptors of indexes created for provided type. See GridCacheSqlIndexMetadata javadoc for more information.

Parameters:

type - Type name.

Returns:

Index descriptors.

See Also:

GridCacheSqlIndexMetadata