構成可能なクエリ（cquery）

問題を報告するopen_in_new ソースを表示open_in_new

cquery は、ビルドグラフに対する select() とビルド オプションの影響を正しく処理する query のバリアントです。

これは、Bazel の分析フェーズの結果を実行することで実現します。分析フェーズにはこれらの効果が統合されています。一方、query は、オプションが評価される前に、Bazel の読み込みフェーズの結果を実行します。

例:

$ cat > tree/BUILD <<EOF
sh_library(
    name = "ash",
    deps = select({
        ":excelsior": [":manna-ash"],
        ":americana": [":white-ash"],
        "//conditions:default": [":common-ash"],
    }),
)
sh_library(name = "manna-ash")
sh_library(name = "white-ash")
sh_library(name = "common-ash")
config_setting(
    name = "excelsior",
    values = {"define": "species=excelsior"},
)
config_setting(
    name = "americana",
    values = {"define": "species=americana"},
)
EOF

# Traditional query: query doesn't know which select() branch you will choose,
# so it conservatively lists all of possible choices, including all used config_settings.
$ bazel query "deps(//tree:ash)" --noimplicit_deps
//tree:americana
//tree:ash
//tree:common-ash
//tree:excelsior
//tree:manna-ash
//tree:white-ash

# cquery: cquery lets you set build options at the command line and chooses
# the exact dependencies that implies (and also the config_setting targets).
$ bazel cquery "deps(//tree:ash)" --define species=excelsior --noimplicit_deps
//tree:ash (9f87702)
//tree:manna-ash (9f87702)
//tree:americana (9f87702)
//tree:excelsior (9f87702)

各結果には、ターゲットのビルドに使用される構成の一意の識別子 (9f87702) が含まれます。

cquery は構成済みのターゲット グラフに対して実行されるため、ビルド アクションなどのアーティファクトに対する分析情報や、[test_suite](/reference/be/general#test_suite) ルールにはターゲットが構成されていないためアクセスできません。前者については、[aquery](/query/aquery) をご覧ください。

基本的な構文

単純な cquery 呼び出しは次のようになります。

bazel cquery "function(//target)"

クエリ式 "function(//target)" は次の要素で構成されます。

• function(...) は、ターゲットで実行する関数です。cquery は、query のほとんどの関数と、いくつかの新しい関数をサポートします。
• //target は、関数に提供される式です。この例では、式は単純なターゲットです。ただし、クエリ言語では関数をネストすることもできます。例については、クエリガイドをご覧ください。

cquery には、読み込みと分析のフェーズを順に実行する必要があります。特に指定のない限り、cquery はクエリ式に記述されているターゲットを解析します。トップレベル ビルド ターゲットの依存関係をクエリする方法については、--universe_scope をご覧ください。

構成

次の行をご覧ください。

//tree:ash (9f87702)

//tree:ash が ID が 9f87702 の構成でビルドされていることを意味します。ほとんどのターゲットでは、これは構成を定義するビルド オプション値の不透明ハッシュです。

構成の全内容を表示するには、次のコマンドを実行します。

$ bazel config 9f87702

9f87702 は完全な ID の接頭辞です。これは、完全な ID は SHA-256 ハッシュであり、長くて追跡しにくいためです。cquery は、完全な Git の有効な接頭辞を認識します。これは Git の短いハッシュに似ています。完全な ID を表示するには、$ bazel config を実行します。

ターゲット パターンの評価

//foo と cquery は query とで意味が異なります。これは、cquery が構成済みのターゲットを評価し、ビルドグラフに //foo の複数の構成済みバージョンが存在する可能性があるためです。

cquery の場合、クエリ式のターゲット パターンは、そのパターンに一致するラベルを持つすべての構成済みターゲットに評価されます。出力は決定論的ですが、cquery は、コアクエリ順序コントラクト以外に順序の保証はありません。

query を使用した場合よりも、クエリ式の結果が小さくなります。たとえば、次のように複数の結果が生成されます。

# Analyzes //foo in the target configuration, but also analyzes
# //genrule_with_foo_as_tool which depends on an exec-configured
# //foo. So there are two configured target instances of //foo in
# the build graph.
$ bazel cquery //foo --universe_scope=//foo,//genrule_with_foo_as_tool
//foo (9f87702)
//foo (exec)

クエリを実行するインスタンスを正確に宣言する場合は、config 関数を使用します。

ターゲット パターンの詳細については、query のターゲット パターンのドキュメントをご覧ください。

関数

query でサポートされている関数セットのうち、cquery は visible、siblings、buildfiles、tests を除くすべての関数をサポートしています。

cquery には、次の新しい関数も導入されています。

構成

expr ::= config(expr, word)

config 演算子は、最初の引数で示されたラベルと 2 番目の引数で指定された構成で構成されたターゲットの検索を試みます。

2 番目の引数の有効な値は、null またはカスタム構成ハッシュです。ハッシュは、$ bazel config または前の cquery の出力から取得できます。

例:

$ bazel cquery "config(//bar, 3732cc8)" --universe_scope=//foo

$ bazel cquery "deps(//foo)"
//bar (exec)
//baz (exec)

$ bazel cquery "config(//baz, 3732cc8)"

指定した引数で最初の引数の結果が見つからない場合は、見つかった結果のみが返されます。指定した構成で結果が見つからない場合、クエリは失敗します。

オプション

ビルド オプション

cquery は通常の Bazel ビルドで実行されるため、ビルド時に使用可能な一連のオプションを継承します。

cquery オプションの使用

--universe_scope（カンマ区切りのリスト）

多くの場合、構成されたターゲットの依存関係は遷移を経ます。そのため、構成が依存先と異なる場合があります。このフラグを使用すると、ターゲットを依存関係としてビルドしたか、別のターゲットの推移的依存関係としてビルドしたかのようにクエリできます。例:

# x/BUILD
genrule(
     name = "my_gen",
     srcs = ["x.in"],
     outs = ["x.cc"],
     cmd = "$(locations :tool) $< >$@",
     tools = [":tool"],
)
cc_library(
    name = "tool",
)

Genrule では、実行構成でツールを構成します。これにより、次のクエリによって次の出力が生成されます。

クエリ	目標達成	出力
bazel cquery "//x:tool"	//x:tool	//x:tool(targetconfig)
bazel cquery "//x:tool" --universe_scope{/9}x:my_gen	//x:my_gen	//x:tool(execconfig)

このフラグが設定されている場合、その内容はビルドされます。設定されていない場合、クエリ式に記載されているすべてのターゲットがビルドされます。ビルドされたターゲットの一時的なクロージングは、クエリ全体で使用されます。いずれの場合も、作成するターゲットはトップレベルで構築できる必要があります（トップレベル オプションと互換性がある必要があります）。cquery は、これらのトップレベル ターゲットの推移的な終了を返します。

クエリ式にすべてのターゲットをトップレベルに構築できる場合でも、作成しない方がよい場合もあります。たとえば、--universe_scope を明示的に設定すると、重要でない構成でターゲットが複数回ビルドされる可能性があります。また、目的のターゲットの構成バージョンの指定にも役立ちます（他の方法で完全に指定することはできないため）。クエリ式が deps(//foo) よりも複雑な場合は、このフラグを設定する必要があります。

--implicit_deps（ブール値、default=True）

このフラグを false に設定すると、BUILD ファイルで明示的に設定されず、Bazel によって別の場所に設定された結果がすべて除外されます。これには、解決済みのツールチェーンのフィルタリングも含まれます。

--tool_deps（ブール値、default=True）

このフラグを false に設定すると、クエリされたターゲットからターゲットへのパスがターゲット構成とターゲット以外の構成の遷移をまたぐ構成済みのターゲットがすべて除外されます。クエリ対象のターゲットがターゲット構成にある場合、--notool_deps を設定すると、ターゲット構成にも含まれているターゲットのみが返されます。クエリされたターゲットがターゲット以外の構成に含まれる場合、--notool_deps を設定すると、ターゲット以外の構成でもターゲットが返されます。通常、この設定は解決されたツールチェーンのフィルタリングには影響しません。

--include_aspects（ブール値、default=True）

アスペクトは、ビルドに依存関係を追加できます。デフォルトでは、cquery は、クエリを実行できるグラフを大きくするメモリを使用します。そのため、アスペクトをフォローしません。ただし、これらの方法を適用すると、より正確な結果が得られます。

大規模なクエリのメモリへの影響が気にならない場合は、bazelrc でこのフラグを有効にします。

アスペクトを無効にしてクエリを実行すると、ターゲット Y のビルド中にターゲット X が失敗する可能性がありますが、cquery somepath(Y, X) と cquery deps(Y) | grep 'X' は依存関係がアスペクトを介して発生するため、結果を返しません。

出力形式

デフォルトでは、cquery はラベルと構成のペアの依存関係順のリストを出力します。結果の公開にはその他のオプションもあります。

遷移

--transitions=lite
--transitions=full

構成遷移は、トップレベル ターゲットとは異なる構成でトップレベル ターゲットの下にターゲットをビルドするために使用されます。

たとえば、ターゲットにより、tools 属性内のすべての依存関係に exec 構成への移行が課されることがあります。これらは属性遷移と呼ばれます。ルールでは、ルールクラス遷移と呼ばれる独自の構成に遷移を課すこともできます。この出力形式には、移行タイプやビルド オプションへの影響など、これらの遷移に関する情報が出力されます。

この出力形式は、デフォルトで NONE に設定されている --transitions フラグによってトリガーされます。FULL または LITE モードに設定できます。FULL モードでは、ルールクラスの遷移と属性の遷移に関する情報が、遷移前後のオプションの詳細な差分を含めて出力されます。LITE モードでは、オプションが差分されずに同じ情報が出力されます。

プロトコル メッセージの出力

--output=proto

このオプションを使用すると、結果のターゲットがバイナリ プロトコル バッファ形式で出力されます。プロトコル バッファの定義は、src/main/protobuf/analysis.proto にあります。

CqueryResult は、cquery の結果を含む最上位レベルのメッセージです。ConfiguredTarget メッセージのリストと Configuration メッセージのリストがあります。各 ConfiguredTarget の configuration_id の値は、対応する Configuration メッセージの id フィールドの値と同じです。

--[no]proto:include_configurations

デフォルトでは、cquery の結果は、構成された各ターゲットの一部として構成情報を返します。この情報を省略して、クエリの proto 出力と厳密にフォーマットされた proto 出力を取得するには、このフラグを false に設定します。

proto 出力関連のオプションについては、クエリの proto 出力ドキュメントをご覧ください。

グラフ出力

--output=graph

このオプションは、Graphviz 互換の .dot ファイルとして出力を生成します。詳しくは、query のグラフ出力のドキュメントをご覧ください。cquery は --graph:node_limit と --graph:factored もサポートしています。

ファイル出力

--output=files

このオプションは、bazel build 呼び出しの最後に出力されるリストと同様に、クエリに一致する各ターゲットによって生成された出力ファイルのリストを出力します。出力には、--output_groups フラグによってリクエストされた出力グループ内でアドバタイズされたファイルのみが含まれます。これにはソースファイルが含まれます。

Starlark を使用した出力形式の定義

--output=starlark

この出力形式では、クエリ結果で構成されたターゲットごとに Starlark 関数を呼び出し、呼び出しによって返された値を出力します。--starlark:file フラグは、単一のパラメータ target を使用して format という名前の関数を定義する Starlark ファイルの場所を指定します。この関数は、クエリ結果の各 Target に対して呼び出されます。または、--starlark:expr フラグを使用して、def format(target): return expr として宣言された関数の本体だけを指定することもできます。

「cquery」スターラーク方言

cquery Starlark 環境は、BUILD ファイルまたは .bzl ファイルとは異なります。すべてのコア Starlark の組み込み定数と関数に加えて、以下で説明する cquery 固有のものも含まれますが、glob、native、rule などは含まれていません。読み込みステートメントはサポートしていません。

build_options（ターゲット）

build_options(target) は、キーがビルド オプション識別子（構成を参照）であり、値が Starlark 値であるマップを返します。有効な Starlark 値ではないビルド オプションは、このマップから省略されています。

ターゲットが入力ファイルの場合、build_options(target) は入力ファイルのターゲットに null 構成があるため、None を返します。

プロバイダ（ターゲット）

providers(target) は、キーがプロバイダの名前（"DefaultInfo" など）で、値が Starlark の値であるマップを返します。有効な Starlark 値ではないプロバイダは、このマップから省略されます。

例

//foo によって生成されたすべてのファイルのベース名のスペース区切りリストを出力します。

  bazel cquery //foo --output=starlark \
    --starlark:expr="' '.join([f.basename for f in target.files.to_list()])"

//bar とそのサブパッケージの rule ターゲットで生成されたすべてのファイルのパスをスペースで区切って出力します。

  bazel cquery 'kind(rule, //bar/...)' --output=starlark \
    --starlark:expr="' '.join([f.path for f in target.files.to_list()])"

//foo によって登録されたすべてのアクションのニーモニックのリストを出力します。

  bazel cquery //foo --output=starlark \
    --starlark:expr="[a.mnemonic for a in target.actions]"

cc_library //baz で登録されたコンパイル出力のリストを出力します。

  bazel cquery //baz --output=starlark \
    --starlark:expr="[f.path for f in target.output_groups.compilation_outputs.to_list()]"

//foo のビルド時に、コマンドライン オプション --javacopt の値を出力します。

  bazel cquery //foo --output=starlark \
    --starlark:expr="build_options(target)['//command_line_option:javacopt']"

各ターゲットのラベルを 1 つの出力で出力します。この例では、ファイルで定義されている Starlark 関数を使用しています。

  $ cat example.cquery

  def has_one_output(target):
    return len(target.files.to_list()) == 1

  def format(target):
    if has_one_output(target):
      return target.label
    else:
      return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

Python 3 の各ラベルを出力するようにします。この例では、ファイルで定義されている Starlark 関数を使用しています。

  $ cat example.cquery

  def format(target):
    p = providers(target)
    py_info = p.get("PyInfo")
    if py_info and py_info.has_py3_only_sources:
      return target.label
    else:
      return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

ユーザー定義のプロバイダから値を抽出します。

  $ cat some_package/my_rule.bzl

  MyRuleInfo = provider(fields={"color": "the name of a color"})

  def _my_rule_impl(ctx):
      ...
      return [MyRuleInfo(color="red")]

  my_rule = rule(
      implementation = _my_rule_impl,
      attrs = {...},
  )

  $ cat example.cquery

  def format(target):
    p = providers(target)
    my_rule_info = p.get("//some_package:my_rule.bzl%MyRuleInfo'")
    if my_rule_info:
      return my_rule_info.color
    return ""

  $ bazel cquery //baz --output=starlark --starlark:file=example.cquery

cquery と query

cquery と query は相互に補完し合い、異なるニッチで卓越しています。次の点を考慮して適切な方法を決定してください。

• cquery は特定の select() ブランチに従って、作成する正確なグラフをモデル化します。query はビルドが選択するブランチを認識しないため、すべてのブランチを含めてオーバーラップします。
• cquery の精度には、query よりも多くのグラフを作成する必要があります。具体的には、cquery は構成されたターゲットを評価しますが、query はターゲットのみを評価します。この場合、時間がかかるうえにメモリも消費します。
• cquery のクエリ言語の解釈により、query が回避する曖昧さが生じます。たとえば、"//foo" が 2 つの構成に存在する場合、cquery "deps(//foo)" ではどれを使用する必要がありますか？これには [config](#config) 関数が役立ちます。
• cquery は新しいツールであるため、特定のユースケースに対応していません。詳しくは、既知の問題をご覧ください。

既知の問題

cquery の「builds」ターゲットはすべて同じ構成にする必要があります。

クエリを評価する前に、cquery はビルド アクションが実行されるポイントの直前にトリガーします。デフォルトでは、「クエリ」に現れるすべてのラベルから「ビルド」されたターゲットが選択されます（これは --universe_scope でオーバーライドできます）。これらの構成は同じにする必要があります。

通常、これらはトップレベルの「ターゲット」構成を共有しますが、ルールは受信エッジ遷移で独自の構成を変更できます。cquery はこれに適していません。

回避策: 可能であれば、--universe_scope に、より厳格なスコープを設定します。例:

# This command attempts to build the transitive closures of both //foo and
# //bar. //bar uses an incoming edge transition to change its --cpu flag.
$ bazel cquery 'somepath(//foo, //bar)'
ERROR: Error doing post analysis query: Top-level targets //foo and //bar
have different configurations (top-level targets with different
configurations is not supported)

# This command only builds the transitive closure of //foo, under which
# //bar should exist in the correct configuration.
$ bazel cquery 'somepath(//foo, //bar)' --universe_scope=//foo

--output=xml はサポートされていません。

非確定的な出力。

cquery は、以前のコマンドのビルドグラフを自動的にワイプしないため、過去のクエリから結果が取得されやすくなります。たとえば、genquery は tools 属性に exec 遷移を実行します。つまり、exec 構成でツールを構成します。

以下に、移行の継続的な効果を示します。

$ cat > foo/BUILD <<<EOF
genrule(
    name = "my_gen",
    srcs = ["x.in"],
    outs = ["x.cc"],
    cmd = "$(locations :tool) $< >$@",
    tools = [":tool"],
)
cc_library(
    name = "tool",
)
EOF

    $ bazel cquery "//foo:tool"
tool(target_config)

    $ bazel cquery "deps(//foo:my_gen)"
my_gen (target_config)
tool (exec_config)
...

    $ bazel cquery "//foo:tool"
tool(exec_config)

回避策: 構成済みのターゲットを強制的に再分析するように起動オプションを変更します。たとえば、--test_arg=<whatever> をビルドコマンドに追加します。

トラブルシューティング

再帰ターゲット パターン（/...）

問題が発生した場合:

$ bazel cquery --universe_scope=//foo:app "somepath(//foo:app, //foo/...)"
ERROR: Error doing post analysis query: Evaluation failed: Unable to load package '[foo]'
because package is not in scope. Check that all target patterns in query expression are within the
--universe_scope of this query.

これは、パッケージ //foo がスコープ外であるものの、--universe_scope=//foo:app に含まれているのに、スコープ外であると誤って示唆しているものです。これは、cquery の設計上の制限によるものです。回避策として、ユニバースの範囲に //foo/... を明示的に指定します。

$ bazel cquery --universe_scope=//foo:app,//foo/... "somepath(//foo:app, //foo/...)"

これがうまくいかない場合（たとえば、//foo/... 内の一部のターゲットが、選択したビルドフラグでビルドできない場合など）、前処理クエリを使用して、パターンを構成要素パッケージに手動でラップ解除します。

# Replace "//foo/..." with a subshell query call (not cquery!) outputting each package, piped into
# a sed call converting "<pkg>" to "//<pkg>:*", piped into a "+"-delimited line merge.
# Output looks like "//foo:*+//foo/bar:*+//foo/baz".
#
$  bazel cquery --universe_scope=//foo:app "somepath(//foo:app, $(bazel query //foo/...
--output=package | sed -e 's/^/\/\//' -e 's/$/:*/' | paste -sd "+" -))"