SqlServerGrammar.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574
  1. <?php
  2. namespace Illuminate\Database\Query\Grammars;
  3. use Illuminate\Database\Query\Builder;
  4. use Illuminate\Database\Query\JoinLateralClause;
  5. use Illuminate\Support\Arr;
  6. use Illuminate\Support\Str;
  7. class SqlServerGrammar extends Grammar
  8. {
  9. /**
  10. * All of the available clause operators.
  11. *
  12. * @var string[]
  13. */
  14. protected $operators = [
  15. '=', '<', '>', '<=', '>=', '!<', '!>', '<>', '!=',
  16. 'like', 'not like', 'ilike',
  17. '&', '&=', '|', '|=', '^', '^=',
  18. ];
  19. /**
  20. * The components that make up a select clause.
  21. *
  22. * @var string[]
  23. */
  24. protected $selectComponents = [
  25. 'aggregate',
  26. 'columns',
  27. 'from',
  28. 'indexHint',
  29. 'joins',
  30. 'wheres',
  31. 'groups',
  32. 'havings',
  33. 'orders',
  34. 'offset',
  35. 'limit',
  36. 'lock',
  37. ];
  38. /**
  39. * Compile a select query into SQL.
  40. *
  41. * @param \Illuminate\Database\Query\Builder $query
  42. * @return string
  43. */
  44. public function compileSelect(Builder $query)
  45. {
  46. // An order by clause is required for SQL Server offset to function...
  47. if ($query->offset && empty($query->orders)) {
  48. $query->orders[] = ['sql' => '(SELECT 0)'];
  49. }
  50. return parent::compileSelect($query);
  51. }
  52. /**
  53. * Compile the "select *" portion of the query.
  54. *
  55. * @param \Illuminate\Database\Query\Builder $query
  56. * @param array $columns
  57. * @return string|null
  58. */
  59. protected function compileColumns(Builder $query, $columns)
  60. {
  61. if (! is_null($query->aggregate)) {
  62. return;
  63. }
  64. $select = $query->distinct ? 'select distinct ' : 'select ';
  65. // If there is a limit on the query, but not an offset, we will add the top
  66. // clause to the query, which serves as a "limit" type clause within the
  67. // SQL Server system similar to the limit keywords available in MySQL.
  68. if (is_numeric($query->limit) && $query->limit > 0 && $query->offset <= 0) {
  69. $select .= 'top '.((int) $query->limit).' ';
  70. }
  71. return $select.$this->columnize($columns);
  72. }
  73. /**
  74. * Compile the "from" portion of the query.
  75. *
  76. * @param \Illuminate\Database\Query\Builder $query
  77. * @param string $table
  78. * @return string
  79. */
  80. protected function compileFrom(Builder $query, $table)
  81. {
  82. $from = parent::compileFrom($query, $table);
  83. if (is_string($query->lock)) {
  84. return $from.' '.$query->lock;
  85. }
  86. if (! is_null($query->lock)) {
  87. return $from.' with(rowlock,'.($query->lock ? 'updlock,' : '').'holdlock)';
  88. }
  89. return $from;
  90. }
  91. /**
  92. * Compile the index hints for the query.
  93. *
  94. * @param \Illuminate\Database\Query\Builder $query
  95. * @param \Illuminate\Database\Query\IndexHint $indexHint
  96. * @return string
  97. */
  98. protected function compileIndexHint(Builder $query, $indexHint)
  99. {
  100. return $indexHint->type === 'force'
  101. ? "with (index({$indexHint->index}))"
  102. : '';
  103. }
  104. /**
  105. * {@inheritdoc}
  106. *
  107. * @param \Illuminate\Database\Query\Builder $query
  108. * @param array $where
  109. * @return string
  110. */
  111. protected function whereBitwise(Builder $query, $where)
  112. {
  113. $value = $this->parameter($where['value']);
  114. $operator = str_replace('?', '??', $where['operator']);
  115. return '('.$this->wrap($where['column']).' '.$operator.' '.$value.') != 0';
  116. }
  117. /**
  118. * Compile a "where date" clause.
  119. *
  120. * @param \Illuminate\Database\Query\Builder $query
  121. * @param array $where
  122. * @return string
  123. */
  124. protected function whereDate(Builder $query, $where)
  125. {
  126. $value = $this->parameter($where['value']);
  127. return 'cast('.$this->wrap($where['column']).' as date) '.$where['operator'].' '.$value;
  128. }
  129. /**
  130. * Compile a "where time" clause.
  131. *
  132. * @param \Illuminate\Database\Query\Builder $query
  133. * @param array $where
  134. * @return string
  135. */
  136. protected function whereTime(Builder $query, $where)
  137. {
  138. $value = $this->parameter($where['value']);
  139. return 'cast('.$this->wrap($where['column']).' as time) '.$where['operator'].' '.$value;
  140. }
  141. /**
  142. * Compile a "JSON contains" statement into SQL.
  143. *
  144. * @param string $column
  145. * @param string $value
  146. * @return string
  147. */
  148. protected function compileJsonContains($column, $value)
  149. {
  150. [$field, $path] = $this->wrapJsonFieldAndPath($column);
  151. return $value.' in (select [value] from openjson('.$field.$path.'))';
  152. }
  153. /**
  154. * Prepare the binding for a "JSON contains" statement.
  155. *
  156. * @param mixed $binding
  157. * @return string
  158. */
  159. public function prepareBindingForJsonContains($binding)
  160. {
  161. return is_bool($binding) ? json_encode($binding) : $binding;
  162. }
  163. /**
  164. * Compile a "JSON contains key" statement into SQL.
  165. *
  166. * @param string $column
  167. * @return string
  168. */
  169. protected function compileJsonContainsKey($column)
  170. {
  171. $segments = explode('->', $column);
  172. $lastSegment = array_pop($segments);
  173. if (preg_match('/\[([0-9]+)\]$/', $lastSegment, $matches)) {
  174. $segments[] = Str::beforeLast($lastSegment, $matches[0]);
  175. $key = $matches[1];
  176. } else {
  177. $key = "'".str_replace("'", "''", $lastSegment)."'";
  178. }
  179. [$field, $path] = $this->wrapJsonFieldAndPath(implode('->', $segments));
  180. return $key.' in (select [key] from openjson('.$field.$path.'))';
  181. }
  182. /**
  183. * Compile a "JSON length" statement into SQL.
  184. *
  185. * @param string $column
  186. * @param string $operator
  187. * @param string $value
  188. * @return string
  189. */
  190. protected function compileJsonLength($column, $operator, $value)
  191. {
  192. [$field, $path] = $this->wrapJsonFieldAndPath($column);
  193. return '(select count(*) from openjson('.$field.$path.')) '.$operator.' '.$value;
  194. }
  195. /**
  196. * Compile a "JSON value cast" statement into SQL.
  197. *
  198. * @param string $value
  199. * @return string
  200. */
  201. public function compileJsonValueCast($value)
  202. {
  203. return 'json_query('.$value.')';
  204. }
  205. /**
  206. * Compile a single having clause.
  207. *
  208. * @param array $having
  209. * @return string
  210. */
  211. protected function compileHaving(array $having)
  212. {
  213. if ($having['type'] === 'Bitwise') {
  214. return $this->compileHavingBitwise($having);
  215. }
  216. return parent::compileHaving($having);
  217. }
  218. /**
  219. * Compile a having clause involving a bitwise operator.
  220. *
  221. * @param array $having
  222. * @return string
  223. */
  224. protected function compileHavingBitwise($having)
  225. {
  226. $column = $this->wrap($having['column']);
  227. $parameter = $this->parameter($having['value']);
  228. return '('.$column.' '.$having['operator'].' '.$parameter.') != 0';
  229. }
  230. /**
  231. * Compile a delete statement without joins into SQL.
  232. *
  233. * @param \Illuminate\Database\Query\Builder $query
  234. * @param string $table
  235. * @param string $where
  236. * @return string
  237. */
  238. protected function compileDeleteWithoutJoins(Builder $query, $table, $where)
  239. {
  240. $sql = parent::compileDeleteWithoutJoins($query, $table, $where);
  241. return ! is_null($query->limit) && $query->limit > 0 && $query->offset <= 0
  242. ? Str::replaceFirst('delete', 'delete top ('.$query->limit.')', $sql)
  243. : $sql;
  244. }
  245. /**
  246. * Compile the random statement into SQL.
  247. *
  248. * @param string|int $seed
  249. * @return string
  250. */
  251. public function compileRandom($seed)
  252. {
  253. return 'NEWID()';
  254. }
  255. /**
  256. * Compile the "limit" portions of the query.
  257. *
  258. * @param \Illuminate\Database\Query\Builder $query
  259. * @param int $limit
  260. * @return string
  261. */
  262. protected function compileLimit(Builder $query, $limit)
  263. {
  264. $limit = (int) $limit;
  265. if ($limit && $query->offset > 0) {
  266. return "fetch next {$limit} rows only";
  267. }
  268. return '';
  269. }
  270. /**
  271. * Compile a row number clause.
  272. *
  273. * @param string $partition
  274. * @param string $orders
  275. * @return string
  276. */
  277. protected function compileRowNumber($partition, $orders)
  278. {
  279. if (empty($orders)) {
  280. $orders = 'order by (select 0)';
  281. }
  282. return parent::compileRowNumber($partition, $orders);
  283. }
  284. /**
  285. * Compile the "offset" portions of the query.
  286. *
  287. * @param \Illuminate\Database\Query\Builder $query
  288. * @param int $offset
  289. * @return string
  290. */
  291. protected function compileOffset(Builder $query, $offset)
  292. {
  293. $offset = (int) $offset;
  294. if ($offset) {
  295. return "offset {$offset} rows";
  296. }
  297. return '';
  298. }
  299. /**
  300. * Compile the lock into SQL.
  301. *
  302. * @param \Illuminate\Database\Query\Builder $query
  303. * @param bool|string $value
  304. * @return string
  305. */
  306. protected function compileLock(Builder $query, $value)
  307. {
  308. return '';
  309. }
  310. /**
  311. * Wrap a union subquery in parentheses.
  312. *
  313. * @param string $sql
  314. * @return string
  315. */
  316. protected function wrapUnion($sql)
  317. {
  318. return 'select * from ('.$sql.') as '.$this->wrapTable('temp_table');
  319. }
  320. /**
  321. * Compile an exists statement into SQL.
  322. *
  323. * @param \Illuminate\Database\Query\Builder $query
  324. * @return string
  325. */
  326. public function compileExists(Builder $query)
  327. {
  328. $existsQuery = clone $query;
  329. $existsQuery->columns = [];
  330. return $this->compileSelect($existsQuery->selectRaw('1 [exists]')->limit(1));
  331. }
  332. /**
  333. * Compile an update statement with joins into SQL.
  334. *
  335. * @param \Illuminate\Database\Query\Builder $query
  336. * @param string $table
  337. * @param string $columns
  338. * @param string $where
  339. * @return string
  340. */
  341. protected function compileUpdateWithJoins(Builder $query, $table, $columns, $where)
  342. {
  343. $alias = last(explode(' as ', $table));
  344. $joins = $this->compileJoins($query, $query->joins);
  345. return "update {$alias} set {$columns} from {$table} {$joins} {$where}";
  346. }
  347. /**
  348. * Compile an "upsert" statement into SQL.
  349. *
  350. * @param \Illuminate\Database\Query\Builder $query
  351. * @param array $values
  352. * @param array $uniqueBy
  353. * @param array $update
  354. * @return string
  355. */
  356. public function compileUpsert(Builder $query, array $values, array $uniqueBy, array $update)
  357. {
  358. $columns = $this->columnize(array_keys(reset($values)));
  359. $sql = 'merge '.$this->wrapTable($query->from).' ';
  360. $parameters = collect($values)->map(function ($record) {
  361. return '('.$this->parameterize($record).')';
  362. })->implode(', ');
  363. $sql .= 'using (values '.$parameters.') '.$this->wrapTable('laravel_source').' ('.$columns.') ';
  364. $on = collect($uniqueBy)->map(function ($column) use ($query) {
  365. return $this->wrap('laravel_source.'.$column).' = '.$this->wrap($query->from.'.'.$column);
  366. })->implode(' and ');
  367. $sql .= 'on '.$on.' ';
  368. if ($update) {
  369. $update = collect($update)->map(function ($value, $key) {
  370. return is_numeric($key)
  371. ? $this->wrap($value).' = '.$this->wrap('laravel_source.'.$value)
  372. : $this->wrap($key).' = '.$this->parameter($value);
  373. })->implode(', ');
  374. $sql .= 'when matched then update set '.$update.' ';
  375. }
  376. $sql .= 'when not matched then insert ('.$columns.') values ('.$columns.');';
  377. return $sql;
  378. }
  379. /**
  380. * Prepare the bindings for an update statement.
  381. *
  382. * @param array $bindings
  383. * @param array $values
  384. * @return array
  385. */
  386. public function prepareBindingsForUpdate(array $bindings, array $values)
  387. {
  388. $cleanBindings = Arr::except($bindings, 'select');
  389. return array_values(
  390. array_merge($values, Arr::flatten($cleanBindings))
  391. );
  392. }
  393. /**
  394. * Compile a "lateral join" clause.
  395. *
  396. * @param \Illuminate\Database\Query\JoinLateralClause $join
  397. * @param string $expression
  398. * @return string
  399. */
  400. public function compileJoinLateral(JoinLateralClause $join, string $expression): string
  401. {
  402. $type = $join->type == 'left' ? 'outer' : 'cross';
  403. return trim("{$type} apply {$expression}");
  404. }
  405. /**
  406. * Compile the SQL statement to define a savepoint.
  407. *
  408. * @param string $name
  409. * @return string
  410. */
  411. public function compileSavepoint($name)
  412. {
  413. return 'SAVE TRANSACTION '.$name;
  414. }
  415. /**
  416. * Compile the SQL statement to execute a savepoint rollback.
  417. *
  418. * @param string $name
  419. * @return string
  420. */
  421. public function compileSavepointRollBack($name)
  422. {
  423. return 'ROLLBACK TRANSACTION '.$name;
  424. }
  425. /**
  426. * Get the format for database stored dates.
  427. *
  428. * @return string
  429. */
  430. public function getDateFormat()
  431. {
  432. return 'Y-m-d H:i:s.v';
  433. }
  434. /**
  435. * Wrap a single string in keyword identifiers.
  436. *
  437. * @param string $value
  438. * @return string
  439. */
  440. protected function wrapValue($value)
  441. {
  442. return $value === '*' ? $value : '['.str_replace(']', ']]', $value).']';
  443. }
  444. /**
  445. * Wrap the given JSON selector.
  446. *
  447. * @param string $value
  448. * @return string
  449. */
  450. protected function wrapJsonSelector($value)
  451. {
  452. [$field, $path] = $this->wrapJsonFieldAndPath($value);
  453. return 'json_value('.$field.$path.')';
  454. }
  455. /**
  456. * Wrap the given JSON boolean value.
  457. *
  458. * @param string $value
  459. * @return string
  460. */
  461. protected function wrapJsonBooleanValue($value)
  462. {
  463. return "'".$value."'";
  464. }
  465. /**
  466. * Wrap a table in keyword identifiers.
  467. *
  468. * @param \Illuminate\Contracts\Database\Query\Expression|string $table
  469. * @return string
  470. */
  471. public function wrapTable($table)
  472. {
  473. if (! $this->isExpression($table)) {
  474. return $this->wrapTableValuedFunction(parent::wrapTable($table));
  475. }
  476. return $this->getValue($table);
  477. }
  478. /**
  479. * Wrap a table in keyword identifiers.
  480. *
  481. * @param string $table
  482. * @return string
  483. */
  484. protected function wrapTableValuedFunction($table)
  485. {
  486. if (preg_match('/^(.+?)(\(.*?\))]$/', $table, $matches) === 1) {
  487. $table = $matches[1].']'.$matches[2];
  488. }
  489. return $table;
  490. }
  491. }