Wikibase
MediaWiki Wikibase extension
Wikibase\Repo\Store\Store Interface Reference

Store interface. More...

+ Inheritance diagram for Wikibase\Repo\Store\Store:

Public Member Functions

 newSiteLinkStore ()
 
 getEntityByLinkedTitleLookup ()
 
 newItemsWithoutSitelinksFinder ()
 
 getEntityRedirectLookup ()
 
 getEntityLookup ( $cache=self::LOOKUP_CACHING_ENABLED, string $lookupMode=LookupConstants::LATEST_FROM_REPLICA)
 
 getEntityRevisionLookup ( $cache=self::LOOKUP_CACHING_ENABLED)
 
 getEntityStore ()
 
 getEntityStoreWatcher ()
 Returns an EntityStoreWatcher that should be notified of changes to entities, in order to keep any caches updated. More...
 
 getPropertyInfoLookup ()
 
 getPropertyInfoStore ()
 
 getEntityPrefetcher ()
 Returns an EntityPrefetcher which can be used to prefetch a list of entity ids in case we need to for example load a batch of entity ids. More...
 
 getEntityChangeLookup ()
 
 getChangeStore ()
 

Public Attributes

const LOOKUP_CACHING_ENABLED = ''
 
const LOOKUP_CACHING_DISABLED = 'uncached'
 
const LOOKUP_CACHING_RETRIEVE_ONLY = 'retrieve-only'
 

Detailed Description

Store interface.

All interaction with store Wikibase does on top of storing pages and associated core MediaWiki indexing is done through this interface.

Todo:
provide getXXX() methods for getting local pseudo-singletons (shared service objects).
Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

◆ getChangeStore()

Wikibase\Repo\Store\Store::getChangeStore ( )
Returns
ChangeStore

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityByLinkedTitleLookup()

Wikibase\Repo\Store\Store::getEntityByLinkedTitleLookup ( )
Returns
EntityByLinkedTitleLookup

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityChangeLookup()

Wikibase\Repo\Store\Store::getEntityChangeLookup ( )
Returns
EntityChangeLookup

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityLookup()

Wikibase\Repo\Store\Store::getEntityLookup (   $cache = self::LOOKUP_CACHING_ENABLED,
string  $lookupMode = LookupConstants::LATEST_FROM_REPLICA 
)
Parameters
string$cacheOne of self::LOOKUP_CACHING_* self::LOOKUP_CACHING_DISABLED to get an uncached direct lookup self::LOOKUP_CACHING_RETRIEVE_ONLY to get a lookup which reads from the cache, but doesn't store retrieved entities self::LOOKUP_CACHING_ENABLED to get a caching lookup (default)
string$lookupModeOne of LookupConstants::LATEST_FROM_*
Returns
EntityLookup

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityPrefetcher()

Wikibase\Repo\Store\Store::getEntityPrefetcher ( )

Returns an EntityPrefetcher which can be used to prefetch a list of entity ids in case we need to for example load a batch of entity ids.

Returns
EntityPrefetcher

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityRedirectLookup()

Wikibase\Repo\Store\Store::getEntityRedirectLookup ( )
Returns
EntityRedirectLookup

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityRevisionLookup()

Wikibase\Repo\Store\Store::getEntityRevisionLookup (   $cache = self::LOOKUP_CACHING_ENABLED)
Parameters
string$cacheOne of self::LOOKUP_CACHING_* self::LOOKUP_CACHING_DISABLED to get an uncached direct lookup self::LOOKUP_CACHING_RETRIEVE_ONLY to get a lookup which reads from the cache, but doesn't store retrieved entities self::LOOKUP_CACHING_ENABLED to get a caching lookup (default)
Returns
EntityRevisionLookup

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityStore()

Wikibase\Repo\Store\Store::getEntityStore ( )
Returns
EntityStore

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getEntityStoreWatcher()

Wikibase\Repo\Store\Store::getEntityStoreWatcher ( )

Returns an EntityStoreWatcher that should be notified of changes to entities, in order to keep any caches updated.

Returns
EntityStoreWatcher

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getPropertyInfoLookup()

Wikibase\Repo\Store\Store::getPropertyInfoLookup ( )
Returns
PropertyInfoLookup

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ getPropertyInfoStore()

Wikibase\Repo\Store\Store::getPropertyInfoStore ( )
Returns
PropertyInfoStore

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

◆ newItemsWithoutSitelinksFinder()

Wikibase\Repo\Store\Store::newItemsWithoutSitelinksFinder ( )

◆ newSiteLinkStore()

Wikibase\Repo\Store\Store::newSiteLinkStore ( )
Returns
SiteLinkStore

Implemented in Wikibase\Repo\Store\Sql\SqlStore.

Member Data Documentation

◆ LOOKUP_CACHING_DISABLED

const Wikibase\Repo\Store\Store::LOOKUP_CACHING_DISABLED = 'uncached'

◆ LOOKUP_CACHING_ENABLED

const Wikibase\Repo\Store\Store::LOOKUP_CACHING_ENABLED = ''

◆ LOOKUP_CACHING_RETRIEVE_ONLY

const Wikibase\Repo\Store\Store::LOOKUP_CACHING_RETRIEVE_ONLY = 'retrieve-only'

The documentation for this interface was generated from the following file: