การค้นหาที่กำหนดค่าได้ (cquery)

รายงานปัญหา ดูแหล่งที่มา

cquery เป็นตัวแปรของ query ที่จัดการ select() และเอฟเฟกต์ของตัวเลือกบิลด์บนกราฟบิลด์ได้อย่างถูกต้อง

ซึ่งทำได้โดยการใช้ผลลัพธ์ของระยะการวิเคราะห์ของ Bazel ซึ่งผสานรวมผลกระทบเหล่านี้เข้าด้วยกัน ในทางตรงกันข้าม query จะทำงานเหนือผลลัพธ์ของระยะการโหลดของ Basl ก่อนที่จะมีการประเมินตัวเลือก

เช่น

$ 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](/versions/6.4.0/reference/be/general#test_suite) เนื่องจากไม่ใช่เป้าหมายที่กำหนดค่าไว้ สำหรับการตั้งค่า โปรดดู [aquery](/versions/6.4.0/docs/aquery)

ไวยากรณ์พื้นฐาน

การโทร cquery แบบง่ายๆ จะมีลักษณะดังนี้

bazel cquery "function(//target)"

นิพจน์การค้นหา "function(//target)" ประกอบด้วยข้อมูลต่อไปนี้

  • function(...) คือฟังก์ชันที่จะเรียกใช้ในเป้าหมาย cquery รองรับฟังก์ชันส่วนใหญ่ของ query รวมถึงฟังก์ชันใหม่อีก 2-3 รายการ
  • //target คือนิพจน์ที่ถูกป้อนไปยังฟังก์ชัน ในตัวอย่างนี้ นิพจน์เป็นเป้าหมายง่ายๆ แต่ภาษาของคำค้นหาก็อนุญาตให้ซ้อนฟังก์ชันต่างๆ ได้เช่นกัน ดูตัวอย่างในวิธีการสืบค้น

cquery ต้องมีเป้าหมายเพื่อเรียกใช้ผ่านเฟสการโหลดและการวิเคราะห์ cquery จะแยกวิเคราะห์เป้าหมายที่แสดงในนิพจน์การค้นหา เว้นแต่จะระบุไว้เป็นอย่างอื่น ดู --universe_scope สำหรับคำค้นหาทรัพยากร Dependency ของเป้าหมายบิลด์ระดับบนสุด

การกำหนดค่า

เส้น:

//tree:ash (9f87702)

หมายความว่า //tree:ash สร้างขึ้นในการกำหนดค่าที่มีรหัส 9f87702 สำหรับเป้าหมายส่วนใหญ่ นี่คือแฮชที่คลุมเครือของค่าตัวเลือกบิลด์ซึ่งเป็นตัวกำหนดการกำหนดค่า

หากต้องการดูเนื้อหาทั้งหมดของการกำหนดค่า ให้เรียกใช้คำสั่งต่อไปนี้

$ bazel config 9f87702

การกำหนดค่าโฮสต์ใช้รหัสพิเศษ (HOST) ไฟล์ต้นฉบับที่ไม่ได้สร้าง เช่น ไฟล์ที่มักพบใน srcs จะใช้รหัสพิเศษ (null) (เนื่องจากไม่จำเป็นต้องกำหนดค่า)

9f87702 คือคำนำหน้าของบัตรประจำตัวที่สมบูรณ์ เพราะรหัสที่สมบูรณ์คือแฮช SHA-256 ซึ่งยาวและติดตามได้ยาก cquery จะเข้าใจคำนำหน้าที่ถูกต้องของรหัสที่สมบูรณ์ ซึ่งคล้ายกับแฮชแบบสั้นของ Git หากต้องการดูรหัสที่สมบูรณ์ ให้เรียกใช้ $ 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 a host-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 (HOST)

หากต้องการประกาศอย่างแม่นยำว่าต้องค้นหาอินสแตนซ์ใด ให้ใช้ฟังก์ชัน config

ดูข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบเป้าหมายได้ในเอกสารประกอบเกี่ยวกับรูปแบบเป้าหมายของ query

ฟังก์ชัน

จากชุดฟังก์ชันที่ query รองรับ มี cquery ที่รองรับทั้งหมดยกเว้น visible, siblings, buildfiles และ tests

cquery ยังมีฟังก์ชันใหม่ดังต่อไปนี้

การกำหนดค่า

expr ::= config(expr, word)

โอเปอเรเตอร์ config จะพยายามค้นหาเป้าหมายที่กำหนดค่าไว้สำหรับป้ายกำกับที่แสดงโดยอาร์กิวเมนต์แรกและการกำหนดค่าที่ระบุโดยอาร์กิวเมนต์ที่ 2

ค่าที่ถูกต้องสำหรับอาร์กิวเมนต์ที่ 2 คือ target, host, null หรือแฮชการกำหนดค่าที่กำหนดเอง คุณเรียกข้อมูลแฮชได้จาก $ bazel config หรือเอาต์พุตของ cquery ก่อนหน้า

ตัวอย่าง

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

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

หากไม่พบผลลัพธ์ทั้งหมดของอาร์กิวเมนต์แรกในการกำหนดค่าที่ระบุ ระบบจะแสดงเฉพาะผลลัพธ์ที่พบเท่านั้น หากไม่พบผลลัพธ์ในการกำหนดค่าที่ระบุ การค้นหาจะล้มเหลว

ตัวเลือก

ตัวเลือกบิลด์

cquery ทำงานเหนือบิลด์ Bazel ปกติ จึงรับชุดตัวเลือกที่ใช้ได้ระหว่างบิลด์

การใช้ตัวเลือกข้อความค้นหา

--universe_scope (รายการที่คั่นด้วยจุลภาค)

ทรัพยากร Dependency ของเป้าหมายที่กําหนดค่าไว้มักจะผ่านการเปลี่ยน ซึ่งทําให้การกําหนดค่าเป้าหมายแตกต่างจากความเกี่ยวข้อง แฟล็กนี้ช่วยให้คุณค้นหาเป้าหมายได้ราวกับว่าเป้าหมายนั้นสร้างขึ้นเป็นทรัพยากร Dependency หรือการขึ้นต่อกันแบบทรานซิทีฟของเป้าหมายอื่น เช่น

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

Genrules จะกำหนดค่าเครื่องมือในการกำหนดค่าโฮสต์ ดังนั้นการค้นหาต่อไปนี้จะสร้างเอาต์พุตต่อไปนี้

การค้นหา สร้างเป้าหมาย เอาต์พุต
bazel cquery "//x:tool" //x:tool //x:tool(targetconfig)
bazel cquery "//x:tool" --universe_scope="//x:my_gen" //x:my_gen //x:tool(hostconfig)

หากมีการตั้งค่าแฟล็กนี้ ระบบจะสร้างเนื้อหาขึ้น หากไม่ได้ตั้งค่าไว้ ระบบจะสร้างเป้าหมายทั้งหมดที่กล่าวถึงในนิพจน์การค้นหาแทน การปิดแบบทางอ้อมของเป้าหมายที่สร้างขึ้นจะใช้เป็นจักรวาลของการค้นหา ไม่ว่าจะเลือกวิธีใด เป้าหมายที่จะสร้างต้องสามารถสร้างได้ที่ระดับบนสุด (ซึ่งก็คือเข้ากันได้กับตัวเลือกระดับบนสุด) cquery แสดงผลลัพธ์การปิดแบบทางอ้อมของเป้าหมายระดับบนสุดเหล่านี้

แม้ว่าคุณจะสร้างเป้าหมายทั้งหมดในนิพจน์การค้นหาที่ระดับบนสุดได้ก็จริง แต่การไม่สร้างเป้าหมายก็อาจมีประโยชน์ เช่น การตั้งค่า --universe_scope อย่างชัดแจ้งอาจป้องกันไม่ให้มีการสร้างเป้าหมายหลายครั้งในการกำหนดค่าที่คุณไม่สนใจ นอกจากนี้ ยังช่วยให้ระบุเวอร์ชันการกำหนดค่าของเป้าหมายที่ต้องการ (เนื่องจากยังไม่สามารถระบุด้วยวิธีอื่นได้อย่างสมบูรณ์ในปัจจุบัน) คุณควรตั้งค่าสถานะนี้หากนิพจน์คำค้นหาซับซ้อนกว่า deps(//foo)

--implicit_deps (บูลีน, default=True)

การตั้งค่าแฟล็กนี้เป็น "เท็จ" จะกรองผลลัพธ์ทั้งหมดที่ไม่ได้ตั้งค่าอย่างชัดเจนในไฟล์ BUILD ออกไป และ Bazel ตั้งค่าไว้ที่อื่นแทน ซึ่งรวมถึงการกรอง toolchain ที่แก้ไขแล้ว

--tool_deps (บูลีน, default=True)

การตั้งค่า Flag นี้เป็น "เท็จ" จะกรองเป้าหมายที่กำหนดค่าไว้ทั้งหมดซึ่งเส้นทางจากเป้าหมายที่ค้นหาไปยังเป้าหมายดังกล่าวข้ามการเปลี่ยนระหว่างการกำหนดค่าเป้าหมายและการกำหนดค่าที่ไม่ใช่เป้าหมาย หากเป้าหมายที่ค้นหาอยู่ในการกำหนดค่าเป้าหมาย การตั้งค่า --notool_deps จะแสดงผลเฉพาะเป้าหมายที่อยู่ในการกำหนดค่าเป้าหมายเท่านั้น หากเป้าหมายที่ค้นหาอยู่ในการกำหนดค่าที่ไม่ใช่เป้าหมาย การตั้งค่า --notool_deps จะแสดงผลเป้าหมายในการกำหนดค่าที่ไม่ใช่เป้าหมายเท่านั้น โดยทั่วไปแล้วการตั้งค่านี้จะไม่ส่งผลต่อการกรอง Toolchain ที่แก้ไขแล้ว

--include_aspects (บูลีน, default=True)

Aspects สามารถเพิ่ม ทรัพยากร Dependency เพิ่มเติมลงในบิลด์ได้ โดยค่าเริ่มต้น cquery จะไม่ติดตามแง่มุมต่างๆ เพราะจะทำให้กราฟที่สืบค้นได้มีขนาดใหญ่ขึ้น ซึ่งใช้หน่วยความจำมากกว่า แต่การปฏิบัติตามกฎจะให้ผลลัพธ์ ที่แม่นยำยิ่งขึ้น

หากคุณไม่ต้องกังวลเกี่ยวกับผลกระทบของหน่วยความจำจากการค้นหาขนาดใหญ่ ให้เปิดใช้งานธงนี้โดยค่าเริ่มต้นใน bazelrc

หากคุณค้นหาโดยปิดใช้ด้านต่างๆ อยู่ คุณอาจพบปัญหาเมื่อเป้าหมาย X ล้มเหลวขณะสร้างเป้าหมาย Y แต่ cquery somepath(Y, X) และ cquery deps(Y) | grep 'X' ไม่แสดงผลลัพธ์เนื่องจากทรัพยากร Dependency เกิดขึ้นผ่านแง่มุมหนึ่ง

รูปแบบเอาต์พุต

โดยค่าเริ่มต้น เอาต์พุต cquery จะแสดงรายการที่เรียงลำดับตามการขึ้นต่อกันของคู่ป้ายกำกับและการกำหนดค่า ยังมีตัวเลือกอื่นๆ ในการแสดงผลลัพธ์ด้วย

ทรานซิชัน

--transitions=lite
--transitions=full

การเปลี่ยนการกำหนดค่าใช้เพื่อสร้างเป้าหมายภายใต้เป้าหมายระดับบนสุดในการกำหนดค่าที่แตกต่างจากเป้าหมายระดับบนสุด

เช่น เป้าหมายอาจกำหนดการเปลี่ยนไปใช้การกำหนดค่าโฮสต์ตามการขึ้นต่อกันทั้งหมดในแอตทริบิวต์ tools ซึ่งเราเรียกว่าการเปลี่ยน แอตทริบิวต์ นอกจากนี้กฎยังกำหนดการเปลี่ยนผ่านการกำหนดค่าของตนเอง หรือที่เรียกว่าการเปลี่ยนคลาสกฎได้อีกด้วย รูปแบบเอาต์พุตนี้จะแสดงข้อมูลเกี่ยวกับการเปลี่ยนเหล่านี้ เช่น ประเภทและผลกระทบที่มีต่อตัวเลือกบิลด์

รูปแบบเอาต์พุตนี้จะทริกเกอร์โดย Flag --transitions ซึ่งตั้งค่าเป็น NONE โดยค่าเริ่มต้น โดยจะตั้งค่าเป็นโหมด FULL หรือ LITE ก็ได้ โหมด FULL จะแสดงผลข้อมูลเกี่ยวกับการเปลี่ยนคลาสของกฎและการเปลี่ยนแอตทริบิวต์ รวมถึงความแตกต่างของตัวเลือกอย่างละเอียดทั้งก่อนและหลังการเปลี่ยน โหมด LITE จะส่งออกข้อมูลเดียวกันโดยไม่มีความแตกต่างของตัวเลือก

เอาต์พุตข้อความโปรโตคอล

--output=proto

ตัวเลือกนี้จะทำให้เป้าหมายที่ได้พิมพ์ในรูปแบบบัฟเฟอร์โปรโตคอลไบนารี ดูคำจำกัดความของบัฟเฟอร์โปรโตคอลได้ที่ src/main/protobuf/analysis.proto

CqueryResult คือข้อความระดับบนสุดที่มีผลลัพธ์ของ cquery ซึ่งจะมีรายการข้อความ ConfiguredTarget รายการและรายการ Configuration ข้อความ ConfiguredTarget แต่ละรายการมี configuration_id ที่มีค่าเท่ากับค่าของช่อง id จากข้อความ Configuration ที่เกี่ยวข้อง

--[no]proto:include_configurations

โดยค่าเริ่มต้น ผลการค้นหา cquery จะแสดงข้อมูลการกำหนดค่าเป็นส่วนหนึ่งของเป้าหมายที่กำหนดค่าแต่ละรายการ หากไม่ต้องการใช้ข้อมูลนี้และรับเอาต์พุต Proto ที่มีการจัดรูปแบบเหมือนกับเอาต์พุต Proto ของคำค้นหาทุกประการ ให้ตั้งค่าแฟล็กนี้เป็น "เท็จ"

ดูเอกสารประกอบเอาต์พุต Proto ของการค้นหาเพื่อดูตัวเลือกเพิ่มเติมเกี่ยวกับเอาต์พุต Pro

ผลลัพธ์ที่เป็นกราฟ

--output=graph

ตัวเลือกนี้จะสร้างเอาต์พุตเป็นไฟล์ .dot ที่สามารถใช้ร่วมกับ Graphviz ได้ ดูรายละเอียดได้ที่เอกสารประกอบเอาต์พุตกราฟของ query cquery ยังรองรับ --graph:node_limit และ --graph:factored ด้วย

เอาต์พุตไฟล์

--output=files

ตัวเลือกนี้จะพิมพ์รายการไฟล์เอาต์พุตที่สร้างโดยแต่ละเป้าหมายซึ่งตรงกับการค้นหาที่คล้ายกับรายการที่พิมพ์เมื่อสิ้นสุดการเรียกใช้ bazel build เอาต์พุตจะมีเฉพาะไฟล์ที่โฆษณาในกลุ่มเอาต์พุตที่ขอตามที่กำหนดโดยแฟล็ก --output_groups ซึ่งรวมถึงไฟล์ต้นฉบับ

การกำหนดรูปแบบเอาต์พุตโดยใช้ Starlark

--output=starlark

รูปแบบเอาต์พุตนี้จะเรียกใช้ฟังก์ชัน Starlark สำหรับเป้าหมายที่กำหนดค่าแต่ละรายการในผลการค้นหา และพิมพ์ค่าที่แสดงผลโดยการเรียกใช้ แฟล็ก --starlark:file ระบุตำแหน่งของไฟล์ Starlark ที่กำหนดฟังก์ชันชื่อ format ด้วยพารามิเตอร์เดียว นั่นคือ target ระบบจะเรียกใช้ฟังก์ชันนี้สำหรับเป้าหมายแต่ละรายการในผลการค้นหา หรือเพื่อความสะดวก คุณอาจระบุเฉพาะเนื้อหาของฟังก์ชันที่ประกาศเป็น def format(target): return expr โดยใช้แฟล็ก --starlark:expr

ภาษาถิ่นสตาร์ลาร์ก "cquery"

สภาพแวดล้อมของ cquery Starlark จะแตกต่างจากไฟล์ BUILD หรือ .bzl ซึ่งรวมค่าคงที่และฟังก์ชันในตัวของ Starlark ทั้งหมด บวกด้วยค่าคงที่และฟังก์ชันเฉพาะการสืบค้นบางส่วนที่อธิบายไว้ด้านล่าง แต่ไม่ใช่ (ตัวอย่างเช่น) glob,native หรือ rule และไม่รองรับคำสั่งโหลด

build_options(target)

build_options(target) จะแสดงผลแผนที่ซึ่งมีคีย์เป็นตัวระบุตัวเลือกบิลด์ (ดูการกำหนดค่า) และค่าที่เป็นค่า Starlark ตัวเลือกในการสร้างที่มีค่าไม่ใช่ค่า Starlark จะถูกละเว้นจากแผนที่นี้

หากเป้าหมายเป็นไฟล์อินพุต build_options(target) จะแสดงผล "ไม่มี" เนื่องจากเป้าหมายไฟล์อินพุตมีการกำหนดค่า Null

ผู้ให้บริการ(เป้าหมาย)

providers(target) จะแสดงผลแผนที่ซึ่งมีคีย์เป็นชื่อของผู้ให้บริการ (เช่น "DefaultInfo") และค่าที่เป็นค่าของ Starlark ผู้ให้บริการที่มีค่าที่ไม่ใช่ค่า Starlark ตามกฎหมายจะไม่รวมอยู่ในแผนที่นี้

ตัวอย่าง

พิมพ์รายการชื่อพื้นฐานของไฟล์ทั้งหมดที่สร้างโดย //foo โดยคั่นด้วยช่องว่าง:

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

พิมพ์รายการเส้นทางของไฟล์ทั้งหมดที่สร้างโดยเป้าหมายกฎใน //bar และแพ็กเกจย่อยที่คั่นด้วยช่องว่าง ดังนี้

  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()]"

พิมพ์ค่าของตัวเลือกบรรทัดคำสั่ง --javacopt เมื่อสร้าง //foo

  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 เทียบกับข้อความค้นหา

cquery และ query ส่งเสริมกันและกัน และโดดเด่นในกลุ่มเป้าหมายที่หลากหลาย ลองตัดสินใจเลือกเครื่องมือต่อไปนี้ที่เหมาะกับคุณ

  • cquery ตาม Branch ของ select() เพื่อสร้างโมเดลกราฟเดียวกับที่คุณสร้าง query ไม่ทราบว่าบิลด์จะเลือก Branch ใด ดังนั้นจึงประมาณค่ามากเกินไปโดยรวม Branch ทั้งหมด
  • ความแม่นยำของ cquery ทำให้ต้องสร้างกราฟมากกว่าที่ query ทำได้ กล่าวโดยละเอียดคือ cquery จะประเมินเป้าหมายที่กำหนดค่า ในขณะที่ query จะประเมินเฉพาะเป้าหมาย ซึ่งจะใช้เวลานานกว่าและใช้หน่วยความจำมากขึ้น
  • การตีความภาษาของคำค้นหาของ cquery ทำให้เกิดความกำกวมที่ query หลีกเลี่ยงได้ เช่น หากมี "//foo" ในการกำหนดค่า 2 รายการ cquery "deps(//foo)" ควรใช้การกำหนดค่าใด ฟังก์ชัน [config](#config) ช่วยคุณได้
  • เนื่องจาก cquery เป็นเครื่องมือที่ใหม่กว่า จึงขาดการรองรับกรณีการใช้งานบางกรณี โปรดดูรายละเอียดในปัญหาที่ทราบ

ปัญหาที่ทราบแล้ว

เป้าหมายทั้งหมดที่ cquery "การสร้าง" ต้องมีการกำหนดค่าเหมือนกัน

ก่อนประเมินการค้นหา cquery จะทริกเกอร์บิลด์จนถึงจุดที่การทำงานของบิลด์จะทำงาน เป้าหมายที่ "สร้าง" จะเลือกจากป้ายกำกับทั้งหมดที่ปรากฏในนิพจน์การค้นหาโดยค่าเริ่มต้น (ลบล้างได้ด้วย --universe_scope) ซึ่งป้ายกำกับเหล่านี้ต้องมีการกำหนดค่าเหมือนกัน

แม้ว่าโดยทั่วไปแล้ว กฎเหล่านี้จะแชร์การกำหนดค่า "เป้าหมาย" ระดับบนสุด แต่กฎจะเปลี่ยนการกำหนดค่าของตนเองได้ด้วยการเปลี่ยน Edge ขาเข้า นี่คือส่วนที่ 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 กล่าวคือ กำหนดค่าเครื่องมือในการกำหนดค่าโฮสต์

คุณสามารถดูผลกระทบที่จะเกิดขึ้นจากการเปลี่ยนผ่านนี้ได้ที่ด้านล่าง

$ 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 (host_config)
...

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

วิธีแก้ปัญหาเบื้องต้นคือ เปลี่ยนตัวเลือกการเริ่มต้นเพื่อบังคับให้มีการวิเคราะห์เป้าหมายที่กำหนดค่าไว้อีกครั้ง เช่น เพิ่ม --test_arg=&lt;whatever&gt; ลงในคำสั่งบิลด์

การแก้ปัญหา

รูปแบบเป้าหมายที่เกิดซ้ำ (/...)

หากคุณพบสิ่งต่อไปนี้

$ 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 "+" -))"