normalized-cache/com.apollographql.cache.normalized.api/Record

Record

class Record(val key: CacheKey, val fields: Map<String, RecordValue?>, val mutationId: Uuid? = null, val metadata: Map<String, Map<String, ApolloJsonElement?>> = emptyMap(), val sizeInBytes: Int = -1) : Map<String, Any?>

A normalized entry that corresponds to a response object. Object fields are stored if they are a GraphQL Scalars. If a field is a GraphQL Object a CacheKey will be stored instead.

Constructors

Record

constructor(key: CacheKey, fields: Map<String, RecordValue?>, mutationId: Uuid? = null, metadata: Map<String, Map<String, ApolloJsonElement?>> = emptyMap(), sizeInBytes: Int = -1)

Types

Companion

object Companion

Properties

entries

open override val entries: Set<Map.Entry<String, Any?>>

fields

val fields: Map<String, RecordValue?>

key

val key: CacheKey

keys

open override val keys: Set<String>

metadata

val metadata: Map<String, Map<String, ApolloJsonElement?>>

Arbitrary metadata that can be attached to each field.

mutationId

val mutationId: Uuid?

size

open override val size: Int

sizeInBytes

val sizeInBytes: Int

Size of the record in bytes. This is an optional field that can be set by the cache implementation for debug purposes, otherwise it defaults to -1, meaning unknown size.

values

open override val values: Collection<Any?>

Functions

containsKey

open override fun containsKey(key: String): Boolean

containsValue

open override fun containsValue(value: Any?): Boolean

expirationDate

fun Record.expirationDate(field: String): Long?

fieldKeys

fun fieldKeys(): Set<String>

Returns a set of all field keys. A field key incorporates any GraphQL arguments in addition to the field name.

get

open operator override fun get(key: String): Any?

getReachableCacheKeys

fun Map<CacheKey, Record>.getReachableCacheKeys(): Set<CacheKey>

isEmpty

open override fun isEmpty(): Boolean

mergeWith

fun mergeWith(newRecord: Record): Pair<Record, Set<String>>

Returns a merge result record and a set of field keys which have changed, or were added. A field key incorporates any GraphQL arguments in addition to the field name.

normalized

fun <D : Executable.Data> DataWithErrors.normalized(executable: Executable<D>, cacheKeyGenerator: CacheKeyGenerator, rootKey: CacheKey = CacheKey.QUERY_ROOT, customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty, metadataGenerator: MetadataGenerator = EmptyMetadataGenerator, fieldKeyGenerator: FieldKeyGenerator = DefaultFieldKeyGenerator, embeddedFieldsProvider: EmbeddedFieldsProvider = EmptyEmbeddedFieldsProvider, maxAgeProvider: MaxAgeProvider = DefaultMaxAgeProvider): Map<CacheKey, Record>

Normalizes this executable data to a map of Record keyed by Record.key.

receivedDate

fun Record.receivedDate(field: String): Long?

referencedFields

fun referencedFields(): List<CacheKey>

Returns the list of referenced cache fields

withDates

fun Record.withDates(receivedDate: String?, expirationDate: String?): Record

withSizeInBytes

fun Record.withSizeInBytes(sizeInBytes: Int): Record