web-dev-qa-db-ja.com

db_select（）を使用して構築されたクエリを出力します

プログラムで db_select（） を使用して構築されたクエリを出力したい。 Drupal抽象化レイヤーによって提供されるAPI関数はありますか？
ビューのクエリ出力に似ていますが、デバッグのためにカスタムモジュールから出力したいと思います。

7database
62
Sithu

SelectQuery implements SelectQuery::__toString() 。これは、文字列が必要なコンテキストで呼び出されます。

次のコードを検討してください。

global $theme_key;

$query = db_select('block')
  ->condition('theme', $theme_key)
  ->condition('status', 1)
  ->fields('block');

print $query;

出力は次のようになります。

SELECT block.*
FROM 
{block} block
WHERE  (theme = :db_condition_placeholder_0) AND (status = :db_condition_placeholder_1)

クエリに使用される引数の配列を取得するには、 SelectQuery::arguments() を呼び出します。

次のコードは、Develモジュールから利用できるようにされた関数を使用して、クエリとその引数を出力します。

global $theme_key;

$query = db_select('block')
  ->condition('theme', $theme_key)
  ->condition('status', 1)
  ->fields('block');

dpm((string) $query);
dpm($query->arguments());

screenshot

ただし、Develモジュールは必須ではなく、drupal_set_message()を使用して出力を表示できます。たとえば、次の関数を使用して、プレースホルダーを実際の値に置き換えた文字列を取得できます。

function _get_query_string(SelectQueryInterface $query) {
  $string = (string) $query;
  $arguments = $query->arguments();

  if (!empty($arguments) && is_array($arguments)) {
    foreach ($arguments as $placeholder => &$value) {
      if (is_string($value)) {
        $value = "'$value'";
      }
    }

    $string = strtr($string, $arguments);
  }

  return $string;
}

前のコード例は、次のコードになります。

global $theme_key;

$query = db_select('block')
  ->condition('theme', $theme_key)
  ->condition('status', 1)
  ->fields('block');

drupal_set_message(format_string('Query: %query', array('%query' => _get_query_string($query))));

function _get_query_string(SelectQueryInterface $query) {
  $string = (string) $query;
  $arguments = $query->arguments();

  if (!empty($arguments) && is_array($arguments)) {
    foreach ($arguments as $placeholder => &$value) {
      if (is_string($value)) {
        $value = "'$value'";
      }
    }

    $string = strtr($string, $arguments);
  }

  return $string;
}

SelectQuery::arguments()は、SelectQuery::__toString()、 SelectQuery::compile() 、または SelectQuery::execute() ;それ以外の場合、SelectQuery::arguments()はNULLを返します。

次のような関数を使用して、プレースホルダーを引数に置き換えた文字列クエリを取得できます。

68
kiamlaluno

dpq（） を使用してクエリを表示し、 dpr（） を使用して結果を表示できます。

  $query = db_select('users','u');
  $query->fields('u');
  $query->condition('u.uid', 1042);
  $result = $query->execute()->fetchAll();

  dpq($query); // Display the query. 
  dpr($result); // Display the query result.
47
umesh

別のオプションは次のとおりです。

global $theme_key;

$query = db_select('block')
  ->condition('theme', $theme_key)
  ->condition('status', 1)
  ->fields('block');

print strtr((string) $query, $query->arguments());
19
vijaycs85

上記の回答は、Develをインストールして構成している場合に適しています。

Develなしでクエリを印刷する最良の方法は以下のとおりです。

$query = db_select('block')
->condition('theme', $theme_key)
->condition('status', 1)
->fields('block');
//One way
echo $query->__toString();
// Second way
echo (string)$query;

上記の方法のいずれかを使用して、クエリを印刷できます。

8
KiranD

Phpmyadminの「SQL」セクションにクエリ文字列を直接コピーして貼り付け、クエリをデバッグできる優れたソリューションがあります（クエリに悩んでいるときにこの方法をよく使用します）。

$querystring=$query->__toString();
$querystring=str_replace("{",'',$querystring);
$querystring=str_replace("}",'',$querystring);
foreach($query->getArguments() as $key=> $item){

    if(!$item) {
        $item = 'NULL';
    }
    $querystring=str_replace($key.')',$item.')',$querystring);
}
dpm($querystring);

これが他の人にとって役に立つことを願っています。

4
Yusef

Drupal 8バージョン：

$query = \Drupal::entityQuery('node')
    ->addTag('debug')
    ->execute();
0
Tien Wang