soil-query-core/soil.query/SwrCache

SwrCache

open class SwrCache(policy: SwrCachePolicy) : SwrClient, QueryMutableClient

Implementation of the SwrClient interface.

Query internally manages two categories:

Active: When there is one or more references or within the QueryOptions.keepAliveTime period
Inactive: When there are no references and past the QueryOptions.keepAliveTime period

Query in the Active state does not disappear from memory unless one of the following conditions is met:

removeQueries is explicitly called

On the other hand, Query in the Inactive state gradually disappears from memory when one of the following conditions is met:

Exceeds the maximum retention count of TimeBasedCache
Past the QueryOptions.gcTime period since saved in TimeBasedCache
gc is executed for unnecessary memory release

Mutation is managed similarly to Active state Query, but it is not explicitly deleted like removeQueries. Typically, since the result of Mutation execution is not reused, it does not cache after going inactive.

Parameters

policy

The policy for the SwrCache.

Inheritors

Constructors

constructor(coroutineScope: CoroutineScope)

constructor(policy: SwrCachePolicy)

Creates a new SwrCache instance.

Types

object Companion

Properties

defaultMutationOptions

open override val defaultMutationOptions: MutationOptions

The default mutation options.

defaultQueryOptions

open override val defaultQueryOptions: QueryOptions

The default query options.

open override val errorRelay: Flow<ErrorRecord>

Provides a unified feedback mechanism for all Query/Mutation errors that occur within the client.

Functions

open override fun gc(level: MemoryPressureLevel)

Releases data in memory based on the specified level.

getInfiniteQuery

open override fun <T, S> getInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker): InfiniteQueryRef<T, S>

Gets the InfiniteQueryRef by the specified InfiniteQueryKey.

getInfiniteQueryData

open override fun <T, S> getInfiniteQueryData(id: InfiniteQueryId<T, S>): QueryChunks<T, S>?

Retrieves data of the InfiniteQueryKey associated with the id.

open override fun <T, S> getMutation(key: MutationKey<T, S>, marker: Marker): MutationRef<T, S>

Gets the MutationRef by the specified MutationKey.

open override fun <T> getQuery(key: QueryKey<T>, marker: Marker): QueryRef<T>

Gets the QueryRef by the specified QueryKey.

open override fun <T> getQueryData(id: QueryId<T>): T?

Retrieves data of the QueryKey associated with the id.

invalidateQueries

open override fun invalidateQueries(filter: InvalidateQueriesFilter)

Invalidates the queries by the specified InvalidateQueriesFilter.

invalidateQueriesBy

open override fun <U : UniqueId> invalidateQueriesBy(vararg ids: U)

Invalidates the queries by the specified UniqueId.

open override fun onMount(id: String)

Executes initialization procedures based on events.

open override fun onUnmount(id: String)

Executes cleanup procedures based on events.

open override fun perform(sideEffects: QueryEffect): Job

Executes side effects for queries.

prefetchInfiniteQuery

open override fun <T, S> prefetchInfiniteQuery(key: InfiniteQueryKey<T, S>, marker: Marker): Job

Prefetches the infinite query by the specified InfiniteQueryKey.

open override fun <T> prefetchQuery(key: QueryKey<T>, marker: Marker): Job

Prefetches the query by the specified QueryKey.

open override fun purgeAll()

Removes all queries and mutations from the in-memory stored data.

open override fun removeQueries(filter: RemoveQueriesFilter)

Removes the queries by the specified RemoveQueriesFilter.

removeQueriesBy

open override fun <U : UniqueId> removeQueriesBy(vararg ids: U)

Removes the queries by the specified UniqueId.

open override fun resumeQueries(filter: ResumeQueriesFilter)

Resumes the queries by the specified ResumeQueriesFilter.

resumeQueriesBy

open override fun <U : UniqueId> resumeQueriesBy(vararg ids: U)

Resumes the queries by the specified UniqueId.

updateInfiniteQueryData

open override fun <T, S> updateInfiniteQueryData(id: InfiniteQueryId<T, S>, edit: QueryChunks<T, S>.() -> QueryChunks<T, S>)

Updates the data of the InfiniteQueryKey associated with the id.

updateQueryData

open override fun <T> updateQueryData(id: QueryId<T>, edit: T.() -> T)

Updates the data of the QueryKey associated with the id.