ConnectionFactory.php 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. <?php
  2. namespace Illuminate\Database\Connectors;
  3. use Illuminate\Contracts\Container\Container;
  4. use Illuminate\Database\Connection;
  5. use Illuminate\Database\MariaDbConnection;
  6. use Illuminate\Database\MySqlConnection;
  7. use Illuminate\Database\PostgresConnection;
  8. use Illuminate\Database\SQLiteConnection;
  9. use Illuminate\Database\SqlServerConnection;
  10. use Illuminate\Support\Arr;
  11. use InvalidArgumentException;
  12. use PDOException;
  13. class ConnectionFactory
  14. {
  15. /**
  16. * The IoC container instance.
  17. *
  18. * @var \Illuminate\Contracts\Container\Container
  19. */
  20. protected $container;
  21. /**
  22. * Create a new connection factory instance.
  23. *
  24. * @param \Illuminate\Contracts\Container\Container $container
  25. * @return void
  26. */
  27. public function __construct(Container $container)
  28. {
  29. $this->container = $container;
  30. }
  31. /**
  32. * Establish a PDO connection based on the configuration.
  33. *
  34. * @param array $config
  35. * @param string|null $name
  36. * @return \Illuminate\Database\Connection
  37. */
  38. public function make(array $config, $name = null)
  39. {
  40. $config = $this->parseConfig($config, $name);
  41. if (isset($config['read'])) {
  42. return $this->createReadWriteConnection($config);
  43. }
  44. return $this->createSingleConnection($config);
  45. }
  46. /**
  47. * Parse and prepare the database configuration.
  48. *
  49. * @param array $config
  50. * @param string $name
  51. * @return array
  52. */
  53. protected function parseConfig(array $config, $name)
  54. {
  55. return Arr::add(Arr::add($config, 'prefix', ''), 'name', $name);
  56. }
  57. /**
  58. * Create a single database connection instance.
  59. *
  60. * @param array $config
  61. * @return \Illuminate\Database\Connection
  62. */
  63. protected function createSingleConnection(array $config)
  64. {
  65. $pdo = $this->createPdoResolver($config);
  66. return $this->createConnection(
  67. $config['driver'], $pdo, $config['database'], $config['prefix'], $config
  68. );
  69. }
  70. /**
  71. * Create a read / write database connection instance.
  72. *
  73. * @param array $config
  74. * @return \Illuminate\Database\Connection
  75. */
  76. protected function createReadWriteConnection(array $config)
  77. {
  78. $connection = $this->createSingleConnection($this->getWriteConfig($config));
  79. return $connection->setReadPdo($this->createReadPdo($config));
  80. }
  81. /**
  82. * Create a new PDO instance for reading.
  83. *
  84. * @param array $config
  85. * @return \Closure
  86. */
  87. protected function createReadPdo(array $config)
  88. {
  89. return $this->createPdoResolver($this->getReadConfig($config));
  90. }
  91. /**
  92. * Get the read configuration for a read / write connection.
  93. *
  94. * @param array $config
  95. * @return array
  96. */
  97. protected function getReadConfig(array $config)
  98. {
  99. return $this->mergeReadWriteConfig(
  100. $config, $this->getReadWriteConfig($config, 'read')
  101. );
  102. }
  103. /**
  104. * Get the write configuration for a read / write connection.
  105. *
  106. * @param array $config
  107. * @return array
  108. */
  109. protected function getWriteConfig(array $config)
  110. {
  111. return $this->mergeReadWriteConfig(
  112. $config, $this->getReadWriteConfig($config, 'write')
  113. );
  114. }
  115. /**
  116. * Get a read / write level configuration.
  117. *
  118. * @param array $config
  119. * @param string $type
  120. * @return array
  121. */
  122. protected function getReadWriteConfig(array $config, $type)
  123. {
  124. return isset($config[$type][0])
  125. ? Arr::random($config[$type])
  126. : $config[$type];
  127. }
  128. /**
  129. * Merge a configuration for a read / write connection.
  130. *
  131. * @param array $config
  132. * @param array $merge
  133. * @return array
  134. */
  135. protected function mergeReadWriteConfig(array $config, array $merge)
  136. {
  137. return Arr::except(array_merge($config, $merge), ['read', 'write']);
  138. }
  139. /**
  140. * Create a new Closure that resolves to a PDO instance.
  141. *
  142. * @param array $config
  143. * @return \Closure
  144. */
  145. protected function createPdoResolver(array $config)
  146. {
  147. return array_key_exists('host', $config)
  148. ? $this->createPdoResolverWithHosts($config)
  149. : $this->createPdoResolverWithoutHosts($config);
  150. }
  151. /**
  152. * Create a new Closure that resolves to a PDO instance with a specific host or an array of hosts.
  153. *
  154. * @param array $config
  155. * @return \Closure
  156. *
  157. * @throws \PDOException
  158. */
  159. protected function createPdoResolverWithHosts(array $config)
  160. {
  161. return function () use ($config) {
  162. foreach (Arr::shuffle($this->parseHosts($config)) as $host) {
  163. $config['host'] = $host;
  164. try {
  165. return $this->createConnector($config)->connect($config);
  166. } catch (PDOException $e) {
  167. continue;
  168. }
  169. }
  170. throw $e;
  171. };
  172. }
  173. /**
  174. * Parse the hosts configuration item into an array.
  175. *
  176. * @param array $config
  177. * @return array
  178. *
  179. * @throws \InvalidArgumentException
  180. */
  181. protected function parseHosts(array $config)
  182. {
  183. $hosts = Arr::wrap($config['host']);
  184. if (empty($hosts)) {
  185. throw new InvalidArgumentException('Database hosts array is empty.');
  186. }
  187. return $hosts;
  188. }
  189. /**
  190. * Create a new Closure that resolves to a PDO instance where there is no configured host.
  191. *
  192. * @param array $config
  193. * @return \Closure
  194. */
  195. protected function createPdoResolverWithoutHosts(array $config)
  196. {
  197. return fn () => $this->createConnector($config)->connect($config);
  198. }
  199. /**
  200. * Create a connector instance based on the configuration.
  201. *
  202. * @param array $config
  203. * @return \Illuminate\Database\Connectors\ConnectorInterface
  204. *
  205. * @throws \InvalidArgumentException
  206. */
  207. public function createConnector(array $config)
  208. {
  209. if (! isset($config['driver'])) {
  210. throw new InvalidArgumentException('A driver must be specified.');
  211. }
  212. if ($this->container->bound($key = "db.connector.{$config['driver']}")) {
  213. return $this->container->make($key);
  214. }
  215. return match ($config['driver']) {
  216. 'mysql' => new MySqlConnector,
  217. 'mariadb' => new MariaDbConnector,
  218. 'pgsql' => new PostgresConnector,
  219. 'sqlite' => new SQLiteConnector,
  220. 'sqlsrv' => new SqlServerConnector,
  221. default => throw new InvalidArgumentException("Unsupported driver [{$config['driver']}]."),
  222. };
  223. }
  224. /**
  225. * Create a new connection instance.
  226. *
  227. * @param string $driver
  228. * @param \PDO|\Closure $connection
  229. * @param string $database
  230. * @param string $prefix
  231. * @param array $config
  232. * @return \Illuminate\Database\Connection
  233. *
  234. * @throws \InvalidArgumentException
  235. */
  236. protected function createConnection($driver, $connection, $database, $prefix = '', array $config = [])
  237. {
  238. if ($resolver = Connection::getResolver($driver)) {
  239. return $resolver($connection, $database, $prefix, $config);
  240. }
  241. return match ($driver) {
  242. 'mysql' => new MySqlConnection($connection, $database, $prefix, $config),
  243. 'mariadb' => new MariaDbConnection($connection, $database, $prefix, $config),
  244. 'pgsql' => new PostgresConnection($connection, $database, $prefix, $config),
  245. 'sqlite' => new SQLiteConnection($connection, $database, $prefix, $config),
  246. 'sqlsrv' => new SqlServerConnection($connection, $database, $prefix, $config),
  247. default => throw new InvalidArgumentException("Unsupported driver [{$driver}]."),
  248. };
  249. }
  250. }