cquery
, select()
ve derleme seçeneklerinin derleme grafiği üzerindeki etkilerini doğru şekilde yöneten query
varyantıdır.
Bunun için Bazel'in bu efektleri entegre eden analiz aşamasının sonuçlarını gözden geçirir. Buna karşılık query
, seçenekler değerlendirilmeden önce Bazel'ın yükleme aşamasının sonuçları üzerinden ilerler.
Örneğin:
$ 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)
Her sonuç, hedefin oluşturulduğu yapılandırmanın benzersiz bir tanımlayıcısını (9f87702)
içerir.
cquery
, yapılandırılan hedef grafiğinde çalıştığından derleme işlemleri gibi yapıların ayrıntılarını görmez ve yapılandırılan hedefler olmadığı için test_suite
kurallarına erişemez. İlki için aquery
bölümüne bakın.
Temel söz dizimi
Basit bir cquery
çağrısı şöyle görünür:
bazel cquery "function(//target)"
"function(//target)"
sorgu ifadesi şunlardan oluşur:
function(...)
, hedefte çalıştırılacak işlevdir.cquery
,query
işlevlerinin çoğunu ve birkaç yeni işlevi destekler.//target
, işleve beslenen ifadedir. Bu örnekte, ifade basit bir hedeftir. Ancak sorgu dili, işlevlerin iç içe yerleştirilmesine de olanak tanır. Örnekler için Sorgu kılavuzuna bakın.
cquery
, yükleme ve analiz aşamalarını tamamlamak için bir hedef gerektirir. Aksi belirtilmedikçe cquery
, sorgu ifadesinde listelenen hedefleri ayrıştırır. Üst düzey derleme hedeflerinin bağımlılıklarını sorgulamak için --universe_scope
bölümüne bakın.
Yapılandırmalar
Satır:
//tree:ash (9f87702)
//tree:ash
ürününün, 9f87702
kimliğine sahip bir yapılandırmada oluşturulduğu anlamına gelir. Çoğu hedef için bu, yapılandırmayı tanımlayan derleme seçeneği değerlerinin opak karmasıdır.
Yapılandırmanın tüm içeriğini görmek için şu komutu çalıştırın:
$ bazel config 9f87702
9f87702
, tam kimliğin ön ekinden oluşur. Bunun nedeni, tam kimliklerin uzun ve takip edilmesi zor olan SHA-256 karmaları olmasıdır. cquery
, Git kısa karmalarına benzer şekilde, tam bir kimliğin geçerli tüm ön eklerini anlar.
Tam kimlikleri görmek için $ bazel config
komutunu çalıştırın.
Hedef kalıp değerlendirmesi
//foo
, cquery
için query
dilinden farklı bir anlama sahiptir. Bunun nedeni, cquery
özelliğinin yapılandırılmış hedefleri değerlendirmesi ve derleme grafiğinde //foo
öğesinin birden fazla yapılandırılmış sürümüne sahip olabilmesidir.
cquery
için sorgu ifadesindeki bir hedef kalıbı, bu kalıpla eşleşen bir etikete sahip her yapılandırılmış hedefe göre değerlendirilir. Çıkış, belirlenebilirdir ancak cquery
, temel sorgu sıralama sözleşmesinin ötesinde herhangi bir sıralama garantisi vermez.
Bu, sorgu ifadeleri için query
ile karşılaştırıldığında daha ince sonuçlar üretir.
Örneğin, aşağıdaki arama terimi birden fazla sonuç verebilir:
# 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)
Sorgulanacak örneği tam olarak belirtmek istiyorsanız config
işlevini kullanın.
Hedef kalıpları hakkında daha fazla bilgi için query
hedef kalıbı belgelerine bakın.
İşlevler
cquery
, query
tarafından desteklenen işlev grubundan visible
, siblings
, buildfiles
ve tests
hariç tüm işlevleri destekler.
cquery
aşağıdaki yeni işlevleri de kullanıma sunuyor:
yapılandırma
expr ::= config(expr, word)
config
operatörü, ilk bağımsız değişken tarafından belirtilen etiket ve ikinci bağımsız değişken tarafından belirtilen yapılandırma için yapılandırılmış hedefi bulmaya çalışır.
İkinci bağımsız değişken için geçerli değerler null
veya özel yapılandırma karması'dır. Karma oluşturma işlemleri $
bazel config
veya önceki bir cquery
'un çıkışından alınabilir.
Örnekler:
$ bazel cquery "config(//bar, 3732cc8)" --universe_scope=//foo
$ bazel cquery "deps(//foo)" //bar (exec) //baz (exec) $ bazel cquery "config(//baz, 3732cc8)"
Belirtilen yapılandırmada ilk bağımsız değişkenin tüm sonuçları bulunamazsa yalnızca bulunabilen sonuçlar döndürülür. Belirtilen yapılandırmada sonuç bulunamazsa sorgu başarısız olur.
Seçenekler
Derleme seçenekleri
cquery
, normal bir Bazel derlemesi üzerinde çalışır ve bu nedenle derleme sırasında kullanılabilen seçenek kümesini devralır.
Sorgu seçeneklerini kullanma
--universe_scope
(virgülle ayrılmış liste)
Yapılandırılmış hedeflerin bağımlılıkları genellikle geçişlerden geçer. Bu da yapılandırmalarının bağımlılarından farklı olmasına neden olur. Bu işaret, bir hedefi başka bir hedefin bağımlılığı veya geçişli bağımlılığı olarak oluşturulmuş gibi sorgulamanıza olanak tanır. Örneğin:
# x/BUILD genrule( name = "my_gen", srcs = ["x.in"], outs = ["x.cc"], cmd = "$(locations :tool) $< >$@", tools = [":tool"], ) cc_binary( name = "tool", srcs = ["tool.cpp"], )
Genrules, araçlarını exec yapılandırmasında yapılandırır. Böylece aşağıdaki sorgular şu çıkışları üretir:
Sorgu | Hedef Oluşturuldu | Çıkış |
---|---|---|
bazel cquery "//x:tool" | //x:tool | //x:tool(targetconfig) |
bazel cquery "//x:tool" --universe_scope="//x:my_gen" | //x:my_gen | //x:tool(execconfig) |
Bu işaret ayarlanırsa içeriği oluşturulur. Ayarlanmazsa sorgu ifadesinde belirtilen tüm hedefler oluşturulur. Oluşturulan hedeflerin geçişli kapatması, sorgunun evreni olarak kullanılır. Her iki durumda da, oluşturulacak hedefler en üst düzeyde derlenebilir (yani üst düzey seçeneklerle uyumlu) olmalıdır. cquery
sonuçları, bu üst düzey hedeflerin geçişli olarak kapatılmasıyla sonuçlanır.
Bir sorgu ifadesindeki tüm hedefleri üst düzeyde oluşturmak mümkün olsa bile bunu yapmamak yararlı olabilir. Örneğin, --universe_scope
değerini açıkça ayarlamak, önemsemediğiniz yapılandırmalarda hedeflerin birden çok kez oluşturulmasını önleyebilir. Ayrıca, bir hedefin hangi yapılandırma sürümünü aradığınızı belirtmenize de yardımcı olabilir (şu anda bunu başka bir şekilde tam olarak belirtmek mümkün olmadığından). Sorgu ifadeniz deps(//foo)
'ten daha karmaşıksa bu işareti ayarlamanız gerekir.
--implicit_deps
(boolean, varsayılan=True)
Bu işaret false olarak ayarlandığında, BUILD dosyasında açıkça ayarlanmayan ve bunun yerine Bazel tarafından başka bir yerde ayarlanan tüm sonuçlar filtrelenir. Buna çözümlenmiş araç zincirlerinin filtrelenmesi de dahildir.
--tool_deps
(boolean, varsayılan=True)
Bu işaret yanlış olarak ayarlanırsa sorgulanan hedeften kendilerine giden yolun, hedef yapılandırması ile hedef olmayan yapılandırmalar arasındaki geçişten geçtiği tüm yapılandırılmış hedefler filtrelenir.
Sorgulanan hedef hedef yapılandırmadaysa --notool_deps
ayarı yalnızca hedef yapılandırmada da bulunan hedefleri döndürür. Sorgulanan hedef, hedef olmayan bir yapılandırmadaysa --notool_deps
ayarlanması, yalnızca hedef olmayan yapılandırmalardaki hedefleri de döndürür. Bu ayar genellikle çözümlenen araç zincirlerinin
filtrelenmesini etkilemez.
--include_aspects
(boolean, varsayılan=True)
Yönler ile eklenen bağımlılıkları dahil edin.
Bu işaret devre dışı bırakılırsa
X yalnızca bir yönden bağımlıysa cquery somepath(X, Y)
ve cquery deps(X) | grep 'Y'
Y değerini atlar.
Çıkış biçimleri
Varsayılan olarak Cquery çıkışları, bağımlılık sıralı bir etiket ve yapılandırma çifti listesiyle sonuçlanır. Sonuçları göstermek için başka seçenekler de vardır.
Geçişler
--transitions=lite --transitions=full
Yapılandırma geçişleri, üst düzey hedeflerden farklı yapılandırmalarda üst düzey hedeflerin altında hedefler oluşturmak için kullanılır.
Örneğin, bir hedef, tools
özelliğindeki tüm bağımlılıklara yönetici yapılandırmasına geçiş uygulayabilir. Bunlara özellik geçişleri denir. Kurallar, kendi yapılandırmalarında geçişler de uygulayabilir. Bu geçişlere kural sınıfı geçişleri denir. Bu çıkış biçimi, geçişlerin türleri ve derleme seçenekleri üzerindeki etkileri gibi geçişlerle ilgili bilgiler verir.
Bu çıkış biçimi, varsayılan olarak NONE
değerine ayarlanmış --transitions
işareti tarafından tetiklenir. FULL
veya LITE
moduna ayarlanabilir. FULL
modu, geçişten önceki ve sonraki seçeneklerin ayrıntılı farklılıkları dahil olmak üzere kural sınıfı geçişleri ve özellik geçişleri hakkında bilgi verir. LITE
modu, seçenekler farkı olmadan aynı bilgileri gösterir.
Protokol mesajı çıkışı
--output=proto
Bu seçenek, sonuçta elde edilen hedeflerin ikili protokol arabelleği biçiminde yazdırılmasına neden olur. Protokol arabelleğinin tanımını src/main/protobuf/analysis_v2.proto adresinde bulabilirsiniz.
CqueryResult
, cquery'nin sonuçlarını içeren üst düzey iletidir. ConfiguredTarget
mesaj ve Configuration
mesajdan oluşan bir liste içerir. Her ConfiguredTarget
, değeri ilgili Configuration
mesajındaki id
alanının değerine eşit olan bir configuration_id
içerir.
--[no]proto:include_configurations
Varsayılan olarak Cquery sonuçları, yapılandırılmış her hedefin bir parçası olarak yapılandırma bilgilerini döndürür. Bu bilgileri çıkarmak ve tam olarak sorgunun proto çıkışı gibi biçimlendirilmiş bir proto çıkışı almak istiyorsanız bu işareti false olarak ayarlayın.
Proto çıkışıyla ilgili daha fazla seçenek için sorgunun proto çıkışı belgelerine bakın.
Grafik çıkışı
--output=graph
Bu seçenek, çıktıyı Graphviz uyumlu bir .dot dosyası olarak oluşturur. Ayrıntılar için query
'ın grafik çıkış dokümanlarına bakın. cquery
, --graph:node_limit
ve --graph:factored
'i de destekler.
Dosya çıkışı
--output=files
Bu seçenek, sorguyla eşleşen her hedef tarafından oluşturulan çıkış dosyalarının listesini (bazel build
çağrısının sonunda yazdırılan listeye benzer) yazdırır. Çıkış, yalnızca --output_groups
işaretiyle belirlenen istenen çıkış gruplarında tanıtılan dosyaları içerir.
Kaynak dosyalar bu kapsama girer.
Bu çıkış biçimi tarafından yayınlanan tüm yollar, bazel info execution_root
aracılığıyla elde edilebilen execroot'a göredir. bazel-out
kolaylık sembolü varsa ana depodaki dosyaların yolları da çalışma alanı dizinine göre çözümlenir.
Starlark'ı kullanarak çıkış biçimini tanımlama
--output=starlark
Bu çıkış biçimi, sorgu sonucundaki her yapılandırılmış hedef için bir Starlark işlevi çağırır ve çağrının döndürdüğü değeri yazdırır. --starlark:file
işareti, tek bir target
parametresine sahip format
adlı bir işlevi tanımlayan bir Starlark dosyasının konumunu belirtir. Bu işlev, sorgu sonucundaki her Hedef için çağrılır. Alternatif olarak, kolaylık sağlaması için --starlark:expr
işaretini kullanarak def format(target): return expr
olarak tanımlanan bir işlevin gövdesini de belirtebilirsiniz.
"cquery" Starlark lehçesi
Sorgu Starlark ortamı, BUILD veya .bzl dosyasından farklı. Tüm temel Starlark yerleşik sabit değerlerini ve işlevlerini ve aşağıda açıklanan sorguya özgü birkaç sabiti içerir, ancak (örneğin) glob
, native
veya rule
içermez ve yükleme ifadelerini desteklemez.
build_options(target)
build_options(target)
, anahtarları derleme seçeneği tanımlayıcıları (Yapılandırmalar bölümüne bakın) ve değerleri Starlark değerleri olan bir harita döndürür. Değerleri geçerli Starlark değerleri olmayan derleme seçenekleri bu haritada atlanır.
Hedef bir giriş dosyasıysa giriş dosyası hedefleri null yapılandırmaya sahip olduğundan build_options(target)
None değerini döndürür.
sağlayıcılar(hedef)
providers(target)
, anahtarları sağlayıcıların adları (örneğin, "DefaultInfo"
) ve değerleri Starlark değerleri olan bir harita döndürür. Değerleri yasal Starlark değerleri olmayan sağlayıcılar bu haritadan çıkarılır.
Örnekler
//foo
tarafından oluşturulan tüm dosyaların temel adlarının boşlukla ayrılmış bir listesini yazdırın:
bazel cquery //foo --output=starlark \ --starlark:expr="' '.join([f.basename for f in target.files.to_list()])"
//bar
ve alt paketlerinde rule hedefleri tarafından oluşturulan tüm dosyaların yollarının boşlukla ayrılmış bir listesini yazdırın:
bazel cquery 'kind(rule, //bar/...)' --output=starlark \ --starlark:expr="' '.join([f.path for f in target.files.to_list()])"
//foo
tarafından kaydedilen tüm işlemlerin anımsatıcılarının listesini yazdırın.
bazel cquery //foo --output=starlark \ --starlark:expr="[a.mnemonic for a in target.actions]"
cc_library
//baz
tarafından kaydedilen derleme çıktılarının listesini yazdırma
bazel cquery //baz --output=starlark \ --starlark:expr="[f.path for f in target.output_groups.compilation_outputs.to_list()]"
//foo
oluştururken --javacopt
komut satırı seçeneğinin değerini yazdırın.
bazel cquery //foo --output=starlark \ --starlark:expr="build_options(target)['//command_line_option:javacopt']"
Her hedefin etiketini tam olarak bir çıkışla yazdırın. Bu örnekte, bir dosyada tanımlanan Starlark işlevleri kullanılmaktadır.
$ 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
Her hedefin etiketini (tam olarak Python 3) yazdırın. Bu örnekte, bir dosyada tanımlanan Starlark işlevleri kullanılmaktadır.
$ 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
Kullanıcı tanımlı bir Sağlayıcıdan değer ayıklayın.
$ 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 ve sorgu
cquery
ve query
birbirini tamamlayarak farklı
nişlerde başarılı oluyor. Sizin için hangisinin uygun olduğuna karar vermek üzere aşağıdakileri göz önünde bulundurun:
cquery
, oluşturduğunuz grafiği tam olarak modellemek için belirliselect()
dallarını izler.query
, derlemenin hangi dalı seçtiğini bilmediği için tüm dalları dahil ederek fazla tahminde bulunur.cquery
işlevinin hassasiyeti,query
ile kıyaslandığında daha fazla grafik oluşturmayı gerektirir. Özellikle,cquery
yapılandırılmış hedefleri,query
ise yalnızca hedefleri değerlendirir. Bu işlem daha uzun sürer ve daha fazla bellek kullanır.cquery
'ın sorgu dili yorumu,query
'ın önlediği bir belirsizlik içeriyor. Örneğin,"//foo"
iki yapılandırmada mevcutsacquery "deps(//foo)"
hangi yapılandırmayı kullanmalıdır?config
işlevi bu konuda yardımcı olabilir.- Daha yeni bir araç olan
cquery
, belirli kullanım alanları için desteğe sahip değildir. Ayrıntılar için Bilinen sorunlar başlıklı makaleyi inceleyin.
Bilinen sorunlar
cquery
"derlediği" tüm hedefler aynı yapılandırmaya sahip olmalıdır.
cquery
, sorguları değerlendirmeden önce derleme işlemlerinin yürütüleceği noktanın hemen öncesinde bir derleme işlemi tetikler. "Oluşturduğu" hedefler varsayılan olarak sorgu ifadesinde görünen tüm etiketlerden seçilir (bu, --universe_scope
ile geçersiz kılınabilir). Bu etiketler aynı yapılandırmaya sahip olmalıdır.
Bunlar genellikle üst düzey "hedef" yapılandırmasını paylaşsa da kurallar, gelen kenar geçişleriyle kendi yapılandırmalarını değiştirebilir.
cquery
bu noktada yetersiz kalır.
Geçici çözüm: Mümkünse --universe_scope
öğesini daha sıkı bir kapsama ayarlayın. Örneğin:
# 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
için destek yok.
Deterministik olmayan çıktı.
cquery
, önceki komutlardaki derleme grafiğini otomatik olarak silmez ve bu nedenle geçmiş sorgulardaki sonuçları alma eğilimindedir. Örneğin, genquery
, tools
özelliğinde bir yürütme geçişi gerçekleştirir. Yani araçlarını yürütme yapılandırmasında yapılandırır.
Bu geçişin süregelen etkilerini aşağıda görebilirsiniz.
$ 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)
Geçici çözüm: Yapılandırılmış hedeflerin yeniden analiz edilmesini zorunlu kılmak için herhangi bir başlangıç seçeneğini değiştirin.
Örneğin, derleme komutunuza --test_arg=<whatever>
ekleyin.
Sorun giderme
Yinelenen hedef kalıpları (/...
)
Aşağıdakilerle karşılaşırsanız:
$ 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.
bu durum, //foo
paketinin --universe_scope=//foo:app
içerdiği hâlde yanlışlıkla
kapsamda olmadığını gösterir. Bunun nedeni cquery
'teki tasarım sınırlamalarıdır. Geçici bir çözüm olarak //foo/...
değerini evren kapsamına açıkça dahil edin:
$ bazel cquery --universe_scope=//foo:app,//foo/... "somepath(//foo:app, //foo/...)"
Bu yöntem işe yaramazsa (örneğin, //foo/...
içindeki bazı hedefler seçilen derleme işaretleriyle derlenemezse) önceden işleme sorgusu kullanarak kalıbı bileşen paketlerine manuel olarak açın:
# 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 "+" -))"