Package com.apple.foundationdb.record

Class RecordMetaData

java.lang.Object

com.apple.foundationdb.record.RecordMetaData

All Implemented Interfaces:

RecordMetaDataProvider

@API(MAINTAINED)
public class RecordMetaData
extends Object
implements RecordMetaDataProvider

Meta-data for Record Layer record stores. Records are represented using Protobuf Messages. Each message Descriptors.Descriptor corresponds to a RecordType. All message types in the database come from a single Descriptors.FileDescriptor. The Protobuf file must also define a union message type (conventionally named RecordTypeUnion) with fields for each of the possible record types. When serializing, the record is put in the corresponding field and the whole saved as a byte string. Then when deserializing, the returned record can be of any of the allowed types. Meta-data can also define any number of secondary Indexes for record types.

See Also:

RecordMetaDataBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RecordMetaData(Descriptors.FileDescriptor recordsDescriptor, Descriptors.Descriptor unionDescriptor, Map<Descriptors.Descriptor,Descriptors.FieldDescriptor> unionFields, Map<String,RecordType> recordTypes, Map<String,SyntheticRecordType<?>> syntheticRecordTypes, Map<String,Index> indexes, Map<String,Index> universalIndexes, List<FormerIndex> formerIndexes, boolean splitLongRecords, boolean storeRecordVersions, int version, long subspaceKeyCounter, boolean usesSubspaceKeyCounter, KeyExpression recordCountKey, boolean usesLocalRecordsDescriptor)

Method Summary

Modifier and Type	Method	Description
static RecordMetaData	build(RecordMetaDataProto.MetaData proto)	Factory method to deserialize a record meta-data proto.
static RecordMetaData	build(Descriptors.FileDescriptor descriptor)
KeyExpression	commonPrimaryKey()	Determine whether every record type in this meta-data has the same primary key.
static KeyExpression	commonPrimaryKey(Collection<RecordType> recordTypes)
List<Index>	getAllIndexes()
List<FormerIndex>	getFormerIndexes()
List<FormerIndex>	getFormerIndexesSince(int version)
Index	getIndex(String indexName)
RecordType	getIndexableRecordType(String name)	Get a record type or synthetic record type by name as used in an index.
Map<Index,List<RecordType>>	getIndexesSince(int version)
Index	getIndexFromSubspaceKey(Object subspaceKey)	Get the index that uses the given subspace key.
KeyExpression	getRecordCountKey()
RecordMetaData	getRecordMetaData()	Get this RecordMetaData instance.
Descriptors.FileDescriptor	getRecordsDescriptor()
RecordType	getRecordType(String name)
RecordType	getRecordTypeForDescriptor(Descriptors.Descriptor descriptor)
RecordType	getRecordTypeFromRecordTypeKey(Object recordTypeKey)	Get the record type that uses the given record type key.
Map<String,RecordType>	getRecordTypes()
long	getSubspaceKeyCounter()	Get value of the counter used for index subspace keys if the counter-based assignment is used.
SyntheticRecordType<?>	getSyntheticRecordType(String name)
SyntheticRecordType<?>	getSyntheticRecordTypeFromRecordTypeKey(Object recordTypeKey)
Map<String,SyntheticRecordType<?>>	getSyntheticRecordTypes()
Descriptors.Descriptor	getUnionDescriptor()
Descriptors.FieldDescriptor	getUnionFieldForRecordType(RecordType recordType)
Index	getUniversalIndex(String indexName)
List<Index>	getUniversalIndexes()
int	getVersion()
boolean	hasIndex(String indexName)
boolean	hasUniversalIndex(String indexName)
boolean	isSplitLongRecords()
boolean	isStoreRecordVersions()
static RecordMetaDataBuilder	newBuilder()	Creates an instance of RecordMetaDataBuilder.
boolean	primaryKeyHasRecordTypePrefix()	Determine whether every record type in this meta-data has RecordType.primaryKeyHasRecordTypePrefix().
Collection<RecordType>	recordTypesForIndex(Index index)
RecordMetaDataProto.MetaData	toProto()	Serializes the record meta-data to a MetaData proto message.
RecordMetaDataProto.MetaData	toProto(Descriptors.FileDescriptor[] excludedDependencies)	Serializes the record meta-data to a MetaData proto message.
boolean	usesSubspaceKeyCounter()	Checks if counter-based subspace key assignment is used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordMetaData

protected RecordMetaData(@Nonnull
                         Descriptors.FileDescriptor recordsDescriptor,
                         @Nonnull
                         Descriptors.Descriptor unionDescriptor,
                         @Nonnull
                         Map<Descriptors.Descriptor,Descriptors.FieldDescriptor> unionFields,
                         @Nonnull
                         Map<String,RecordType> recordTypes,
                         @Nonnull
                         Map<String,SyntheticRecordType<?>> syntheticRecordTypes,
                         @Nonnull
                         Map<String,Index> indexes,
                         @Nonnull
                         Map<String,Index> universalIndexes,
                         @Nonnull
                         List<FormerIndex> formerIndexes,
                         boolean splitLongRecords,
                         boolean storeRecordVersions,
                         int version,
                         long subspaceKeyCounter,
                         boolean usesSubspaceKeyCounter,
                         @Nullable
                         KeyExpression recordCountKey,
                         boolean usesLocalRecordsDescriptor)

Method Detail

newBuilder

@Nonnull
public static RecordMetaDataBuilder newBuilder()

Creates an instance of RecordMetaDataBuilder.

Returns:

a new builder

getRecordsDescriptor

@Nonnull
public Descriptors.FileDescriptor getRecordsDescriptor()

getUnionDescriptor

@Nonnull
public Descriptors.Descriptor getUnionDescriptor()

getUnionFieldForRecordType

@Nonnull
public Descriptors.FieldDescriptor getUnionFieldForRecordType(@Nonnull
                                                              RecordType recordType)

getRecordTypes

@Nonnull
public Map<String,RecordType> getRecordTypes()

getRecordType

@Nonnull
public RecordType getRecordType(@Nonnull
                                String name)

getRecordTypeForDescriptor

@Nonnull
public RecordType getRecordTypeForDescriptor(@Nonnull
                                             Descriptors.Descriptor descriptor)

getRecordTypeFromRecordTypeKey

@Nonnull
public RecordType getRecordTypeFromRecordTypeKey(@Nonnull
                                                 Object recordTypeKey)

Get the record type that uses the given record type key.

Parameters:

recordTypeKey - the key used as a prefix for some record type

Returns:

the record type

Throws:

MetaDataException - if the given key does not correspond to any record type

getSyntheticRecordTypes

@Nonnull
@API(EXPERIMENTAL)
public Map<String,SyntheticRecordType<?>> getSyntheticRecordTypes()

getSyntheticRecordType

@Nonnull
@API(EXPERIMENTAL)
public SyntheticRecordType<?> getSyntheticRecordType(@Nonnull
                                                     String name)

getSyntheticRecordTypeFromRecordTypeKey

@Nonnull
@API(EXPERIMENTAL)
public SyntheticRecordType<?> getSyntheticRecordTypeFromRecordTypeKey(@Nonnull
                                                                      Object recordTypeKey)

getIndexableRecordType

public RecordType getIndexableRecordType(@Nonnull
                                         String name)

Get a record type or synthetic record type by name as used in an index.

Parameters:

name - the name of the record type

Returns:

the possibly synthetic record type

getIndex

@Nonnull
public Index getIndex(@Nonnull
                      String indexName)

hasIndex

public boolean hasIndex(@Nonnull
                        String indexName)

getAllIndexes

@Nonnull
public List<Index> getAllIndexes()

getIndexFromSubspaceKey

@Nonnull
public Index getIndexFromSubspaceKey(@Nonnull
                                     Object subspaceKey)

Get the index that uses the given subspace key.

Parameters:

subspaceKey - the key used as a prefix for some index

Returns:

the index

Throws:

MetaDataException - if the given key does not correspond to any index

getUniversalIndex

@Nonnull
public Index getUniversalIndex(@Nonnull
                               String indexName)

hasUniversalIndex

public boolean hasUniversalIndex(@Nonnull
                                 String indexName)

getUniversalIndexes

@Nonnull
public List<Index> getUniversalIndexes()

getFormerIndexes

public List<FormerIndex> getFormerIndexes()

isSplitLongRecords

public boolean isSplitLongRecords()

isStoreRecordVersions

public boolean isStoreRecordVersions()

getVersion

public int getVersion()

getSubspaceKeyCounter

public long getSubspaceKeyCounter()

Get value of the counter used for index subspace keys if the counter-based assignment is used.

Returns:

the value of the counter

See Also:

RecordMetaDataBuilder.enableCounterBasedSubspaceKeys()

usesSubspaceKeyCounter

public boolean usesSubspaceKeyCounter()

Checks if counter-based subspace key assignment is used.

Returns:

true if the subspace key counter is used

See Also:

RecordMetaDataBuilder.enableCounterBasedSubspaceKeys()

getFormerIndexesSince

public List<FormerIndex> getFormerIndexesSince(int version)

getIndexesSince

public Map<Index,List<RecordType>> getIndexesSince(int version)

recordTypesForIndex

@Nonnull
public Collection<RecordType> recordTypesForIndex(@Nonnull
                                                  Index index)

getRecordCountKey

@Nullable
@API(DEPRECATED)
public KeyExpression getRecordCountKey()

primaryKeyHasRecordTypePrefix

public boolean primaryKeyHasRecordTypePrefix()

Determine whether every record type in this meta-data has RecordType.primaryKeyHasRecordTypePrefix(). If so, records are strictly partitioned by record type.

Returns:

true if every record type has a record type prefix on the primary key

commonPrimaryKey

@Nullable
public KeyExpression commonPrimaryKey()

Determine whether every record type in this meta-data has the same primary key.

Returns:

the common primary key or null

commonPrimaryKey

@Nullable
public static KeyExpression commonPrimaryKey(@Nonnull
                                             Collection<RecordType> recordTypes)

getRecordMetaData

@Nonnull
public RecordMetaData getRecordMetaData()

Get this RecordMetaData instance.

Specified by:

getRecordMetaData in interface RecordMetaDataProvider

Returns:

this RecordMetaData instance

build

@Nonnull
public static RecordMetaData build(@Nonnull
                                   Descriptors.FileDescriptor descriptor)

build

@Nonnull
public static RecordMetaData build(@Nonnull
                                   RecordMetaDataProto.MetaData proto)

Factory method to deserialize a record meta-data proto. It assumes that the proto contains all of the dependencies and does not process extension options.

Parameters:

proto - the serialized proto message of the RecordMetaData

Returns:

the RecordMetaData object

toProto

@Nonnull
public RecordMetaDataProto.MetaData toProto()

Serializes the record meta-data to a MetaData proto message. By default, it includes all of the dependencies except TupleFieldsProto, RecordMetaDataOptionsProto and RecordMetaDataProto.

Note that if this record meta-data object was created with a local file descriptor, then serializing the meta-data to a proto message is disallowed. This is because setting a local file descriptor can change the meta-data in ways that would change its serialization, but it also will not update the meta-data version. This means that if the meta-data were then saved to disk, existing clients would not be informed that the meta-data had been updated.

Returns:

the serialized MetaData proto message

Throws:

KeyExpression.SerializationException - on any serialization failures

MetaDataException - if this RecordMetaData was initialized with a local file descriptor

toProto

@Nonnull
public RecordMetaDataProto.MetaData toProto(@Nullable
                                            Descriptors.FileDescriptor[] excludedDependencies)
                                     throws KeyExpression.SerializationException

Serializes the record meta-data to a MetaData proto message. This operates like toProto() except that any dependency in the excluded list is not included in the serialized proto message. If the list is set to null, then all dependencies will be serialized to the proto message including those that are execluded by default.

Parameters:

excludedDependencies - a list of dependencies not to include in the serialized proto

Returns:

the serialized MetaData proto message

Throws:

KeyExpression.SerializationException - on any serialization failures

MetaDataException - if this RecordMetaData was initialized with a local file descriptor

See Also:

toProto()