MongoDBEntityStore::getEntityLookup() - Code Metrics - Inspection of "Switch to WikibaseDataModel 4 and WikibaseDataMode..." - ProjetPP/WikibaseEntityStore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Thomas

created 2015-12-17 21:00 UTC

MongoDBEntityStore::getEntityLookup() A

↳ Parent: MongoDBEntityStore

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace Wikibase\EntityStore\MongoDB;

use Doctrine\MongoDB\Database;
use Wikibase\DataModel\Entity\BasicEntityIdParser;
use Wikibase\EntityStore\EntityDocumentSaver;
use Wikibase\EntityStore\EntityStore;
use Wikibase\EntityStore\EntityStoreOptions;
use Wikibase\EntityStore\Internal\DispatchingEntityIdForQueryLookup;
use Wikibase\EntityStore\Internal\DispatchingEntityIdForTermLookup;
use Wikibase\EntityStore\Internal\DispatchingEntityLookup;
use Wikibase\EntityStore\Internal\EntitySerializationFactory;

/**
 * @licence GPLv2+
 * @author Thomas Pellissier Tanon
 *
 * @todo add indexes if all languages are supported
 */
class MongoDBEntityStore extends EntityStore {

	/**
	 * Option to set the time limit for query operations in milliseconds.
	 */
	const OPTION_QUERY_TIME_LIMIT = 'mongodb-query-time-limit';

	/**
	 * @var Database
	 */
	private $database;

	/**
	 * @var DispatchingEntityLookup
	 */
	private $entityLookup;

	/**
	 * @var DispatchingEntityIdForTermLookup
	 */
	private $entityForTermLookup;

	/**
	 * @var DispatchingEntityIdForQueryLookup
	 */
	private $entityForQueryLookup;

	/**
	 * @var EntityDocumentSaver
	 */
	private $entitySaver;

	/**
	 * @param Database $database
	 * @param EntityStoreOptions $options
	 */
	public function __construct( Database $database, EntityStoreOptions $options = null ) {
		$this->database = $database;

		parent::__construct( $options );
		$this->defaultOption( self::OPTION_QUERY_TIME_LIMIT, null );

		$entityDatabase = $this->newEntityDatabase( $database );
		$this->entityLookup = new DispatchingEntityLookup( $entityDatabase );
		$this->entityForTermLookup = new DispatchingEntityIdForTermLookup( $this->newEntityIdForTermLookup( $database ) );
		$this->entityForQueryLookup = new DispatchingEntityIdForQueryLookup( $this->newEntityIdForQueryLookup( $database ) );
		$this->entitySaver = $entityDatabase;
	}

	private function newEntityDatabase( Database $database ) {
		return new MongoDBEntityDatabase( $database, $this->newDocumentBuilder() );
	}

	private function newEntityIdForTermLookup( Database $database ) {
		return new MongoDBEntityIdForTermLookup( $database, $this->newDocumentBuilder() );
	}

	private function newEntityIdForQueryLookup( Database $database ) {
		return new MongoDBEntityIdForQueryLookup(
			$database,
			$this->newDocumentBuilder(),
			$this->getOption( self::OPTION_QUERY_TIME_LIMIT )
		);
	}

	private function newDocumentBuilder() {
		$serialization = new EntitySerializationFactory();
		return new MongoDBDocumentBuilder(
			$serialization->newEntitySerializer(),
			$serialization->newEntityDeserializer(),
			new BasicEntityIdParser(),
			$this->getOptions()
		);
	}

	/**
	 * @see EntityStore::getEntityLookup
	 */
	public function getEntityLookup() {
		return $this->entityLookup;
	}

	/**
	 * @see EntityStore::getEntityDocumentLookup
	 */
	public function getEntityDocumentLookup() {
		return $this->entityLookup;
	}

	/**
	 * @see EntityStore::getItemLookup
	 */
	public function getItemLookup() {
		return $this->entityLookup;
	}

	/**
	 * @see EntityStore::getPropertyLookup
	 */
	public function getPropertyLookup() {
		return $this->entityLookup;
	}

	/**
	 * @see EntityStore::getEntityDocumentSaver
	 */
	public function getEntityDocumentSaver() {
		return $this->entitySaver;
	}

	/**
	 * @see EntityStore::getItemIdForTermLookup
	 */
	public function getItemIdForTermLookup() {
		return $this->entityForTermLookup;
	}

	/**
	 * @see EntityStore::getPropertyIdForTermLookup
	 */
	public function getPropertyIdForTermLookup() {
		return $this->entityForTermLookup;
	}

	/**
	 * @see EntityStore::getItemIdForQueryLookup
	 */
	public function getItemIdForQueryLookup() {
		return $this->entityForQueryLookup;
	}

	/**
	 * @see EntityStore::getPropertyIdForQueryLookup
	 */
	public function getPropertyIdForQueryLookup() {
		return $this->entityForQueryLookup;
	}

	/**
	 * @see EntityStore::setupStore
	 */
	public function setupStore() {
		foreach( MongoDBDocumentBuilder::$SUPPORTED_ENTITY_TYPES as $type ) {
			$this->database->command( [
				'collMod' => $type,
				'usePowerOf2Sizes' => true
			] );
		}
	}

	/**
	 * @see EntityStore::setupIndexes
	 */
	public function setupIndexes() {
		$this->setupTermIndexes();
		$this->setupClaimsIndexes();
	}

	private function setupTermIndexes() {
		$languagesOption = $this->getOption( EntityStore::OPTION_LANGUAGES );

		if( $languagesOption === null ) {
			return;
		}

		foreach( $languagesOption as $language ) {
			$key = 'sterms.' . $language;

			foreach( MongoDBDocumentBuilder::$SUPPORTED_ENTITY_TYPES as $type ) {
				$this->database->selectCollection( $type )->ensureIndex(
					[ $key => 1 ],
					[ 'sparse' => true, 'socketTimeoutMS' => -1 ]
				);
			}
		}
	}

	private function setupClaimsIndexes() {
		foreach( MongoDBDocumentBuilder::$SUPPORTED_ENTITY_TYPES as $entityType ) {
			$collection = $this->database->selectCollection( $entityType );

			foreach( MongoDBDocumentBuilder::$SUPPORTED_DATAVALUE_TYPES as $dataValueType ) {
				$key = 'sclaims.' . $dataValueType;
				$collection->ensureIndex(
					[ $key => 1 ],
					[ 'sparse' => true, 'socketTimeoutMS' => -1 ]
				);
			}
		}
	}
}


1		<?php
2
3		namespace Wikibase\EntityStore\MongoDB;
4
5		use Doctrine\MongoDB\Database;
6		use Wikibase\DataModel\Entity\BasicEntityIdParser;
7		use Wikibase\EntityStore\EntityDocumentSaver;
8		use Wikibase\EntityStore\EntityStore;
9		use Wikibase\EntityStore\EntityStoreOptions;
10		use Wikibase\EntityStore\Internal\DispatchingEntityIdForQueryLookup;
11		use Wikibase\EntityStore\Internal\DispatchingEntityIdForTermLookup;
12		use Wikibase\EntityStore\Internal\DispatchingEntityLookup;
13		use Wikibase\EntityStore\Internal\EntitySerializationFactory;
14
15		/**
16		* @licence GPLv2+
17		* @author Thomas Pellissier Tanon
18		*
19		* @todo add indexes if all languages are supported
20		*/
21		class MongoDBEntityStore extends EntityStore {
22
23		/**
24		* Option to set the time limit for query operations in milliseconds.
25		*/
26		const OPTION_QUERY_TIME_LIMIT = 'mongodb-query-time-limit';
27
28		/**
29		* @var Database
30		*/
31		private $database;
32
33		/**
34		* @var DispatchingEntityLookup
35		*/
36		private $entityLookup;
37
38		/**
39		* @var DispatchingEntityIdForTermLookup
40		*/
41		private $entityForTermLookup;
42
43		/**
44		* @var DispatchingEntityIdForQueryLookup
45		*/
46		private $entityForQueryLookup;
47
48		/**
49		* @var EntityDocumentSaver
50		*/
51		private $entitySaver;
52
53		/**
54		* @param Database $database
55		* @param EntityStoreOptions $options
56		*/
57	10	public function __construct( Database $database, EntityStoreOptions $options = null ) {
58	10	$this->database = $database;
59
60	10	parent::__construct( $options );
61	10	$this->defaultOption( self::OPTION_QUERY_TIME_LIMIT, null );
62
63	10	$entityDatabase = $this->newEntityDatabase( $database );
64	10	$this->entityLookup = new DispatchingEntityLookup( $entityDatabase );
65	10	$this->entityForTermLookup = new DispatchingEntityIdForTermLookup( $this->newEntityIdForTermLookup( $database ) );
66	10	$this->entityForQueryLookup = new DispatchingEntityIdForQueryLookup( $this->newEntityIdForQueryLookup( $database ) );
67	10	$this->entitySaver = $entityDatabase;
68	10	}
69
70	10	private function newEntityDatabase( Database $database ) {
71	10	return new MongoDBEntityDatabase( $database, $this->newDocumentBuilder() );
72		}
73
74	10	private function newEntityIdForTermLookup( Database $database ) {
75	10	return new MongoDBEntityIdForTermLookup( $database, $this->newDocumentBuilder() );
76		}
77
78	10	private function newEntityIdForQueryLookup( Database $database ) {
79	10	return new MongoDBEntityIdForQueryLookup(
80	10	$database,
81	10	$this->newDocumentBuilder(),
82	10	$this->getOption( self::OPTION_QUERY_TIME_LIMIT )
83	10	);
84		}
85
86	10	private function newDocumentBuilder() {
87	10	$serialization = new EntitySerializationFactory();
88	10	return new MongoDBDocumentBuilder(
89	10	$serialization->newEntitySerializer(),
90	10	$serialization->newEntityDeserializer(),
91	10	new BasicEntityIdParser(),
92	10	$this->getOptions()
93	10	);
94		}
95
96		/**
97		* @see EntityStore::getEntityLookup
98		*/
99	1	public function getEntityLookup() {
100	1	return $this->entityLookup;
101		}
102
103		/**
104		* @see EntityStore::getEntityDocumentLookup
105		*/
106	2	public function getEntityDocumentLookup() {
107	2	return $this->entityLookup;
108		}
109
110		/**
111		* @see EntityStore::getItemLookup
112		*/
113	2	public function getItemLookup() {
114	2	return $this->entityLookup;
115		}
116
117		/**
118		* @see EntityStore::getPropertyLookup
119		*/
120	2	public function getPropertyLookup() {
121	2	return $this->entityLookup;
122		}
123
124		/**
125		* @see EntityStore::getEntityDocumentSaver
126		*/
127	2	public function getEntityDocumentSaver() {
128	2	return $this->entitySaver;
129		}
130
131		/**
132		* @see EntityStore::getItemIdForTermLookup
133		*/
134	2	public function getItemIdForTermLookup() {
135	2	return $this->entityForTermLookup;
136		}
137
138		/**
139		* @see EntityStore::getPropertyIdForTermLookup
140		*/
141	2	public function getPropertyIdForTermLookup() {
142	2	return $this->entityForTermLookup;
143		}
144
145		/**
146		* @see EntityStore::getItemIdForQueryLookup
147		*/
148	2	public function getItemIdForQueryLookup() {
149	2	return $this->entityForQueryLookup;
150		}
151
152		/**
153		* @see EntityStore::getPropertyIdForQueryLookup
154		*/
155	2	public function getPropertyIdForQueryLookup() {
156	2	return $this->entityForQueryLookup;
157		}
158
159		/**
160		* @see EntityStore::setupStore
161		*/
162	1	public function setupStore() {
163	1	foreach( MongoDBDocumentBuilder::$SUPPORTED_ENTITY_TYPES as $type ) {
164	1	$this->database->command( [
165	1	'collMod' => $type,
166		'usePowerOf2Sizes' => true
167	1	] );
168	1	}
169	1	}
170
171		/**
172		* @see EntityStore::setupIndexes
173		*/
174	1	public function setupIndexes() {
175	1	$this->setupTermIndexes();
176	1	$this->setupClaimsIndexes();
177	1	}
178
179	1	private function setupTermIndexes() {
180	1	$languagesOption = $this->getOption( EntityStore::OPTION_LANGUAGES );
181
182	1	if( $languagesOption === null ) {
183		return;
184		}
185
186	1	foreach( $languagesOption as $language ) {
187	1	$key = 'sterms.' . $language;
188
189	1	foreach( MongoDBDocumentBuilder::$SUPPORTED_ENTITY_TYPES as $type ) {
190	1	$this->database->selectCollection( $type )->ensureIndex(
191	1	[ $key => 1 ],
192	1	[ 'sparse' => true, 'socketTimeoutMS' => -1 ]
193	1	);
194	1	}
195	1	}
196	1	}
197
198	1	private function setupClaimsIndexes() {
199	1	foreach( MongoDBDocumentBuilder::$SUPPORTED_ENTITY_TYPES as $entityType ) {
200	1	$collection = $this->database->selectCollection( $entityType );
201
202	1	foreach( MongoDBDocumentBuilder::$SUPPORTED_DATAVALUE_TYPES as $dataValueType ) {
203	1	$key = 'sclaims.' . $dataValueType;
204	1	$collection->ensureIndex(
205	1	[ $key => 1 ],
206	1	[ 'sparse' => true, 'socketTimeoutMS' => -1 ]
207	1	);
208	1	}
209	1	}
210	1	}
211		}
212

ProjetPP / WikibaseEntityStore

Pull Request — master (#16)

MongoDBEntityStore::getEntityLookup() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like