[{"data":1,"prerenderedAt":1484},["ShallowReactive",2],{"navigation-zh":3,"navigation-v1":81,"\u002Fzh\u002Fguide\u002Fquery-parameters":146,"\u002Fzh\u002Fguide\u002Fquery-parameters-surround":868,"\u002Fzh\u002Fguide\u002Fquery-parameters-og":873},[4,55,77],{"title":5,"path":6,"stem":7,"children":8},"指南","\u002Fzh\u002Fguide","zh\u002F1.guide\u002F01.index",[9,11,15,19,23,27,31,35,39,43,47,51],{"title":10,"path":6,"stem":7},"介绍",{"title":12,"path":13,"stem":14},"序言","\u002Fzh\u002Fguide\u002Fprologue","zh\u002F1.guide\u002F00.prologue",{"title":16,"path":17,"stem":18},"快速上手","\u002Fzh\u002Fguide\u002Fgetting-started","zh\u002F1.guide\u002F02.getting-started",{"title":20,"path":21,"stem":22},"模型","\u002Fzh\u002Fguide\u002Fmodels","zh\u002F1.guide\u002F03.models",{"title":24,"path":25,"stem":26},"关联","\u002Fzh\u002Fguide\u002Frelationships","zh\u002F1.guide\u002F04.relationships",{"title":28,"path":29,"stem":30},"钩子","\u002Fzh\u002Fguide\u002Fhooks","zh\u002F1.guide\u002F05.hooks",{"title":32,"path":33,"stem":34},"搜索","\u002Fzh\u002Fguide\u002Fsearch","zh\u002F1.guide\u002F06.search",{"title":36,"path":37,"stem":38},"批量操作","\u002Fzh\u002Fguide\u002Fbatch-operations","zh\u002F1.guide\u002F07.batch-operations",{"title":40,"path":41,"stem":42},"查询参数","\u002Fzh\u002Fguide\u002Fquery-parameters","zh\u002F1.guide\u002F08.query-parameters",{"title":44,"path":45,"stem":46},"安全","\u002Fzh\u002Fguide\u002Fsecurity","zh\u002F1.guide\u002F09.security",{"title":48,"path":49,"stem":50},"响应","\u002Fzh\u002Fguide\u002Fresponses","zh\u002F1.guide\u002F10.responses",{"title":52,"path":53,"stem":54},"规范","\u002Fzh\u002Fguide\u002Fspecifications","zh\u002F1.guide\u002F11.specifications",{"title":56,"path":57,"stem":58,"children":59},"TypeScript SDK","\u002Fzh\u002Ftypescript-sdk","zh\u002F2.typescript-sdk\u002F01.index",[60,61,64,68,71,74],{"title":10,"path":57,"stem":58},{"title":16,"path":62,"stem":63},"\u002Fzh\u002Ftypescript-sdk\u002Fgetting-started","zh\u002F2.typescript-sdk\u002F02.getting-started",{"title":65,"path":66,"stem":67},"配置","\u002Fzh\u002Ftypescript-sdk\u002Fconfiguration","zh\u002F2.typescript-sdk\u002F03.configuration",{"title":20,"path":69,"stem":70},"\u002Fzh\u002Ftypescript-sdk\u002Fmodels","zh\u002F2.typescript-sdk\u002F04.models",{"title":24,"path":72,"stem":73},"\u002Fzh\u002Ftypescript-sdk\u002Frelationships","zh\u002F2.typescript-sdk\u002F05.relationships",{"title":40,"path":75,"stem":76},"\u002Fzh\u002Ftypescript-sdk\u002Fquery-parameters","zh\u002F2.typescript-sdk\u002F06.query-parameters",{"title":78,"path":79,"stem":80},"视频教程","\u002Fzh\u002Fscreencasts","zh\u002Fscreencasts",[82,125],{"title":83,"path":84,"stem":85,"children":86},"Guide","\u002Fv1.x\u002Fguide","v1.x\u002F1.guide\u002F01.index",[87,89,93,97,101,105,109,113,117,121],{"title":88,"path":84,"stem":85},"Introduction",{"title":90,"path":91,"stem":92},"Getting Started","\u002Fv1.x\u002Fguide\u002Fgetting-started","v1.x\u002F1.guide\u002F02.getting-started",{"title":94,"path":95,"stem":96},"Models","\u002Fv1.x\u002Fguide\u002Fmodels","v1.x\u002F1.guide\u002F03.models",{"title":98,"path":99,"stem":100},"Relationships","\u002Fv1.x\u002Fguide\u002Frelationships","v1.x\u002F1.guide\u002F04.relationships",{"title":102,"path":103,"stem":104},"Hooks","\u002Fv1.x\u002Fguide\u002Fhooks","v1.x\u002F1.guide\u002F05.hooks",{"title":106,"path":107,"stem":108},"Search","\u002Fv1.x\u002Fguide\u002Fsearch","v1.x\u002F1.guide\u002F06.search",{"title":110,"path":111,"stem":112},"Batch Operations","\u002Fv1.x\u002Fguide\u002Fbatch-operations","v1.x\u002F1.guide\u002F07.batch-operations",{"title":114,"path":115,"stem":116},"Query Parameters","\u002Fv1.x\u002Fguide\u002Fquery-parameters","v1.x\u002F1.guide\u002F08.query-parameters",{"title":118,"path":119,"stem":120},"Security","\u002Fv1.x\u002Fguide\u002Fsecurity","v1.x\u002F1.guide\u002F09.security",{"title":122,"path":123,"stem":124},"Responses","\u002Fv1.x\u002Fguide\u002Fresponses","v1.x\u002F1.guide\u002F10.responses",{"title":56,"path":126,"stem":127,"children":128},"\u002Fv1.x\u002Ftypescript-sdk","v1.x\u002F2.typescript-sdk\u002F01.index",[129,130,133,137,140,143],{"title":88,"path":126,"stem":127},{"title":90,"path":131,"stem":132},"\u002Fv1.x\u002Ftypescript-sdk\u002Fgetting-started","v1.x\u002F2.typescript-sdk\u002F02.getting-started",{"title":134,"path":135,"stem":136},"Configuration","\u002Fv1.x\u002Ftypescript-sdk\u002Fconfiguration","v1.x\u002F2.typescript-sdk\u002F03.configuration",{"title":94,"path":138,"stem":139},"\u002Fv1.x\u002Ftypescript-sdk\u002Fmodels","v1.x\u002F2.typescript-sdk\u002F04.models",{"title":98,"path":141,"stem":142},"\u002Fv1.x\u002Ftypescript-sdk\u002Frelationships","v1.x\u002F2.typescript-sdk\u002F05.relationships",{"title":114,"path":144,"stem":145},"\u002Fv1.x\u002Ftypescript-sdk\u002Fquery-parameters","v1.x\u002F2.typescript-sdk\u002F06.query-parameters",{"id":147,"title":40,"body":148,"description":862,"extension":863,"links":864,"meta":865,"navigation":312,"path":41,"seo":866,"stem":42,"__hash__":867},"docs_zh\u002Fzh\u002F1.guide\u002F08.query-parameters.md",{"type":149,"value":150,"toc":852},"minimark",[151,155,159,163,170,176,201,237,240,254,275,278,291,508,514,533,553,556,561,715,718,726,729,814,817,823,830,848],[152,153,154],"p",{},"Orion 允许 API 使用者通过查询参数与可软删除的资源交互、在响应中一并包含其他相关资源（定义在特定模型上的关联）、对关联和\u002F或字段进行聚合，以及指定响应中返回的资源数量（分页限制）。",[156,157,158],"h2",{"id":158},"软删除",[160,161,162],"h3",{"id":162},"返回已软删除的资源",[152,164,165,169],{},[166,167,168],"code",{},"with_trashed"," 查询参数允许你返回所有资源，包括已删除的资源。",[152,171,172,175],{},[166,173,174],{},"only_trashed"," 查询参数指示 API 仅返回已软删除的资源。",[152,177,178,179,184,185,188,189,192,193,196,197,200],{},"这些参数在",[180,181,183],"a",{"href":182},"\u002Fzh\u002Fguide\u002Fmodels#%E8%BD%AF%E5%88%A0%E9%99%A4","标准","资源和",[180,186,24],{"href":187},"\u002Fzh\u002Fguide\u002Frelationships#%E8%BD%AF%E5%88%A0%E9%99%A4","资源的 ",[166,190,191],{},"index","、",[166,194,195],{},"search"," 和 ",[166,198,199],{},"show"," 端点上均可使用。",[202,203,208],"pre",{"className":204,"code":205,"language":206,"meta":207,"style":207},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?with_trashed=true\n","bash","",[166,209,210],{"__ignoreMap":207},[211,212,215,219,223,226,229,233],"span",{"class":213,"line":214},"line",1,[211,216,218],{"class":217},"sMK4o","(",[211,220,222],{"class":221},"sBMFI","GET",[211,224,225],{"class":217},")",[211,227,228],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?with_trashed",[211,230,232],{"class":231},"sfazB","=",[211,234,236],{"class":235},"s2Zo4","true\n",[160,238,239],{"id":239},"强制删除",[152,241,242,243,246,247,184,249,188,251,200],{},"最后，",[166,244,245],{},"force"," 查询参数允许你永久删除资源。该参数在",[180,248,183],{"href":182},[180,250,24],{"href":187},[166,252,253],{},"destroy",[202,255,257],{"className":204,"code":256,"language":206,"meta":207,"style":207},"(DELETE) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts\u002F5?force=true\n",[166,258,259],{"__ignoreMap":207},[211,260,261,263,266,268,271,273],{"class":213,"line":214},[211,262,218],{"class":217},[211,264,265],{"class":221},"DELETE",[211,267,225],{"class":217},[211,269,270],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts\u002F5?force",[211,272,232],{"class":231},[211,274,236],{"class":235},[156,276,277],{"id":277},"分页限制",[152,279,280,281,283,284,286,287,290],{},"默认情况下，",[166,282,191],{}," 或 ",[166,285,195],{}," 端点每页返回 15 个实体。要自定义该数量，请使用 ",[166,288,289],{},"limit"," 方法：",[202,292,296],{"className":293,"code":294,"language":295,"meta":207,"style":207},"language-php shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","\u003C?php\n\nnamespace App\\Http\\Controllers\\Api;\n\nuse Orion\\Http\\Controllers\\Controller;\n\nclass PostsController extends Controller\n{\n    ...\n\n    \u002F**\n    * 默认分页限制。\n    *\n    * @return int\n    *\u002F\n    public function limit() : int\n    {\n        return 20;\n    }\n\n    ...\n}\n","php",[166,297,298,307,314,343,348,372,377,393,399,405,410,417,423,429,442,448,468,474,486,492,497,502],{"__ignoreMap":207},[211,299,300,303],{"class":213,"line":214},[211,301,302],{"class":217},"\u003C?",[211,304,306],{"class":305},"sTEyZ","php\n",[211,308,310],{"class":213,"line":309},2,[211,311,313],{"emptyLinePlaceholder":312},true,"\n",[211,315,317,321,324,327,330,332,335,337,340],{"class":213,"line":316},3,[211,318,320],{"class":319},"sbssI","namespace",[211,322,323],{"class":221}," App",[211,325,326],{"class":217},"\\",[211,328,329],{"class":221},"Http",[211,331,326],{"class":217},[211,333,334],{"class":221},"Controllers",[211,336,326],{"class":217},[211,338,339],{"class":221},"Api",[211,341,342],{"class":217},";\n",[211,344,346],{"class":213,"line":345},4,[211,347,313],{"emptyLinePlaceholder":312},[211,349,351,354,357,359,361,363,365,367,370],{"class":213,"line":350},5,[211,352,353],{"class":319},"use",[211,355,356],{"class":305}," Orion",[211,358,326],{"class":217},[211,360,329],{"class":305},[211,362,326],{"class":217},[211,364,334],{"class":305},[211,366,326],{"class":217},[211,368,369],{"class":305},"Controller",[211,371,342],{"class":217},[211,373,375],{"class":213,"line":374},6,[211,376,313],{"emptyLinePlaceholder":312},[211,378,380,384,387,390],{"class":213,"line":379},7,[211,381,383],{"class":382},"spNyl","class",[211,385,386],{"class":221}," PostsController",[211,388,389],{"class":382}," extends",[211,391,392],{"class":221}," Controller\n",[211,394,396],{"class":213,"line":395},8,[211,397,398],{"class":217},"{\n",[211,400,402],{"class":213,"line":401},9,[211,403,404],{"class":217},"    ...\n",[211,406,408],{"class":213,"line":407},10,[211,409,313],{"emptyLinePlaceholder":312},[211,411,413],{"class":213,"line":412},11,[211,414,416],{"class":415},"sHwdD","    \u002F**\n",[211,418,420],{"class":213,"line":419},12,[211,421,422],{"class":415},"    * 默认分页限制。\n",[211,424,426],{"class":213,"line":425},13,[211,427,428],{"class":415},"    *\n",[211,430,432,435,439],{"class":213,"line":431},14,[211,433,434],{"class":415},"    * ",[211,436,438],{"class":437},"svl4J","@return",[211,440,441],{"class":437}," int\n",[211,443,445],{"class":213,"line":444},15,[211,446,447],{"class":415},"    *\u002F\n",[211,449,451,454,457,460,463,466],{"class":213,"line":450},16,[211,452,453],{"class":382},"    public",[211,455,456],{"class":382}," function",[211,458,459],{"class":235}," limit",[211,461,462],{"class":217},"()",[211,464,465],{"class":217}," :",[211,467,441],{"class":319},[211,469,471],{"class":213,"line":470},17,[211,472,473],{"class":217},"    {\n",[211,475,477,481,484],{"class":213,"line":476},18,[211,478,480],{"class":479},"s7zQu","        return",[211,482,483],{"class":319}," 20",[211,485,342],{"class":217},[211,487,489],{"class":213,"line":488},19,[211,490,491],{"class":217},"    }\n",[211,493,495],{"class":213,"line":494},20,[211,496,313],{"emptyLinePlaceholder":312},[211,498,500],{"class":213,"line":499},21,[211,501,404],{"class":217},[211,503,505],{"class":213,"line":504},22,[211,506,507],{"class":217},"}\n",[152,509,510,511,513],{},"要指示 API 每页返回特定数量的实体，URL 中需要包含 ",[166,512,289],{}," 查询参数。",[202,515,517],{"className":204,"code":516,"language":206,"meta":207,"style":207},"(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?limit=30\n",[166,518,519],{"__ignoreMap":207},[211,520,521,523,525,527,530],{"class":213,"line":214},[211,522,218],{"class":217},[211,524,222],{"class":221},[211,526,225],{"class":217},[211,528,529],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?limit",[211,531,532],{"class":231},"=30\n",[534,535,536],"warning",{},[152,537,538,540,541,545,546,548,549,552],{},[166,539,289],{}," 查询参数中指定的值",[542,543,544],"em",{},"总是","会覆盖控制器上 ",[166,547,289],{}," 方法中指定的值，但它永远不能超过 ",[166,550,551],{},"maxLimit"," 方法中指定的值。",[156,554,555],{"id":555},"最大分页限制",[152,557,558,559,290],{},"默认情况下，可从 API 请求的实体数量没有上限。要自定义该行为，请使用 ",[166,560,551],{},[202,562,564],{"className":293,"code":563,"language":295,"meta":207,"style":207},"\u003C?php\n\nnamespace App\\Http\\Controllers\\Api;\n\nuse Orion\\Http\\Controllers\\Controller;\n\nclass PostsController extends Controller\n{\n    ...\n\n    \u002F**\n    * 最大分页限制。\n    *\n    * @return int\n    *\u002F\n    public function maxLimit() : int\n    {\n        return 100;\n    }\n\n    ...\n}\n",[166,565,566,572,576,596,600,620,624,634,638,642,646,650,655,659,667,671,686,690,699,703,707,711],{"__ignoreMap":207},[211,567,568,570],{"class":213,"line":214},[211,569,302],{"class":217},[211,571,306],{"class":305},[211,573,574],{"class":213,"line":309},[211,575,313],{"emptyLinePlaceholder":312},[211,577,578,580,582,584,586,588,590,592,594],{"class":213,"line":316},[211,579,320],{"class":319},[211,581,323],{"class":221},[211,583,326],{"class":217},[211,585,329],{"class":221},[211,587,326],{"class":217},[211,589,334],{"class":221},[211,591,326],{"class":217},[211,593,339],{"class":221},[211,595,342],{"class":217},[211,597,598],{"class":213,"line":345},[211,599,313],{"emptyLinePlaceholder":312},[211,601,602,604,606,608,610,612,614,616,618],{"class":213,"line":350},[211,603,353],{"class":319},[211,605,356],{"class":305},[211,607,326],{"class":217},[211,609,329],{"class":305},[211,611,326],{"class":217},[211,613,334],{"class":305},[211,615,326],{"class":217},[211,617,369],{"class":305},[211,619,342],{"class":217},[211,621,622],{"class":213,"line":374},[211,623,313],{"emptyLinePlaceholder":312},[211,625,626,628,630,632],{"class":213,"line":379},[211,627,383],{"class":382},[211,629,386],{"class":221},[211,631,389],{"class":382},[211,633,392],{"class":221},[211,635,636],{"class":213,"line":395},[211,637,398],{"class":217},[211,639,640],{"class":213,"line":401},[211,641,404],{"class":217},[211,643,644],{"class":213,"line":407},[211,645,313],{"emptyLinePlaceholder":312},[211,647,648],{"class":213,"line":412},[211,649,416],{"class":415},[211,651,652],{"class":213,"line":419},[211,653,654],{"class":415},"    * 最大分页限制。\n",[211,656,657],{"class":213,"line":425},[211,658,428],{"class":415},[211,660,661,663,665],{"class":213,"line":431},[211,662,434],{"class":415},[211,664,438],{"class":437},[211,666,441],{"class":437},[211,668,669],{"class":213,"line":444},[211,670,447],{"class":415},[211,672,673,675,677,680,682,684],{"class":213,"line":450},[211,674,453],{"class":382},[211,676,456],{"class":382},[211,678,679],{"class":235}," maxLimit",[211,681,462],{"class":217},[211,683,465],{"class":217},[211,685,441],{"class":319},[211,687,688],{"class":213,"line":470},[211,689,473],{"class":217},[211,691,692,694,697],{"class":213,"line":476},[211,693,480],{"class":479},[211,695,696],{"class":319}," 100",[211,698,342],{"class":217},[211,700,701],{"class":213,"line":488},[211,702,491],{"class":217},[211,704,705],{"class":213,"line":494},[211,706,313],{"emptyLinePlaceholder":312},[211,708,709],{"class":213,"line":499},[211,710,404],{"class":217},[211,712,713],{"class":213,"line":504},[211,714,507],{"class":217},[156,716,717],{"id":717},"聚合",[152,719,720,721,725],{},"首先，用于聚合的关联和字段需要加入",[180,722,724],{"href":723},"\u002Fzh\u002Fguide\u002Fsearch#%E8%81%9A%E5%90%88","白名单","。",[152,727,728],{},"要指示 API 返回聚合结果，URL 中需要包含特定的查询参数，其值为以逗号分隔的关联或字段列表。",[202,730,732],{"className":204,"code":731,"language":206,"meta":207,"style":207},"(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?with_count=user,meta\n(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?with_exists=user,meta\n(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_avg=posts.stars\n(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_sum=posts.stars\n(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_min=posts.stars\n(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_max=posts.stars\n",[166,733,734,748,761,775,788,801],{"__ignoreMap":207},[211,735,736,738,740,742,745],{"class":213,"line":214},[211,737,218],{"class":217},[211,739,222],{"class":221},[211,741,225],{"class":217},[211,743,744],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?with_count",[211,746,747],{"class":231},"=user,meta\n",[211,749,750,752,754,756,759],{"class":213,"line":309},[211,751,218],{"class":217},[211,753,222],{"class":221},[211,755,225],{"class":217},[211,757,758],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?with_exists",[211,760,747],{"class":231},[211,762,763,765,767,769,772],{"class":213,"line":316},[211,764,218],{"class":217},[211,766,222],{"class":221},[211,768,225],{"class":217},[211,770,771],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_avg",[211,773,774],{"class":231},"=posts.stars\n",[211,776,777,779,781,783,786],{"class":213,"line":345},[211,778,218],{"class":217},[211,780,222],{"class":221},[211,782,225],{"class":217},[211,784,785],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_sum",[211,787,774],{"class":231},[211,789,790,792,794,796,799],{"class":213,"line":350},[211,791,218],{"class":217},[211,793,222],{"class":221},[211,795,225],{"class":217},[211,797,798],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_min",[211,800,774],{"class":231},[211,802,803,805,807,809,812],{"class":213,"line":374},[211,804,218],{"class":217},[211,806,222],{"class":221},[211,808,225],{"class":217},[211,810,811],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fusers?with_max",[211,813,774],{"class":231},[156,815,816],{"id":816},"包含关联",[152,818,819,820,725],{},"首先，关联需要加入",[180,821,724],{"href":822},"\u002Fzh\u002Fguide\u002Fsearch#%E5%8C%85%E5%90%AB",[152,824,825,826,829],{},"要指示 API 返回关联，URL 中需要包含 ",[166,827,828],{},"include"," 查询参数，其值为以逗号分隔的关联列表。",[202,831,833],{"className":204,"code":832,"language":206,"meta":207,"style":207},"(GET) https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?include=user,meta\n",[166,834,835],{"__ignoreMap":207},[211,836,837,839,841,843,846],{"class":213,"line":214},[211,838,218],{"class":217},[211,840,222],{"class":221},[211,842,225],{"class":217},[211,844,845],{"class":221}," https:\u002F\u002Fmyapp.com\u002Fapi\u002Fposts?include",[211,847,747],{"class":231},[849,850,851],"style",{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .svl4J, html code.shiki .svl4J{--shiki-light:#F76D47;--shiki-light-font-style:italic;--shiki-default:#F78C6C;--shiki-default-font-style:italic;--shiki-dark:#F78C6C;--shiki-dark-font-style:italic}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}",{"title":207,"searchDepth":214,"depth":309,"links":853},[854,858,859,860,861],{"id":158,"depth":309,"text":158,"children":855},[856,857],{"id":162,"depth":316,"text":162},{"id":239,"depth":316,"text":239},{"id":277,"depth":309,"text":277},{"id":555,"depth":309,"text":555},{"id":717,"depth":309,"text":717},{"id":816,"depth":309,"text":816},"了解有哪些可用的查询参数以及如何使用它们。","md",null,{},{"title":40,"description":862},"p0Efe8C5pp4_AZSYZYQRiNc89yPFA6RwWZo-dAOYwuE",[869,871],{"title":36,"path":37,"stem":38,"description":870,"children":-1},"了解如何以批量方式管理实体。",{"title":44,"path":45,"stem":46,"description":872,"children":-1},"了解认证、授权与验证。",{"id":874,"title":114,"body":875,"description":1478,"extension":863,"links":864,"meta":1479,"navigation":312,"path":1480,"seo":1481,"stem":1482,"__hash__":1483},"docs_en\u002F1.guide\u002F08.query-parameters.md",{"type":149,"value":876,"toc":1468},[877,880,884,888,894,899,921,939,943,956,974,978,990,1142,1148,1164,1182,1186,1191,1343,1347,1355,1358,1434,1438,1444,1450,1466],[152,878,879],{},"Orion allows consumers of your API to use query parameters for interaction with soft deletable resources, including other related resources (defined as relations on a particular model) together in the response, aggregating relations and\u002For fields, and specifying how many resources to return in the response (pagination limit).",[156,881,883],{"id":882},"soft-deletes","Soft Deletes",[160,885,887],{"id":886},"returning-trashed-resources","Returning Trashed Resources",[152,889,890,891,893],{},"The ",[166,892,168],{}," query parameter allows you to return all resources, even the deleted ones.",[152,895,890,896,898],{},[166,897,174],{}," query parameter instructs the API to return only soft deleted resources.",[152,900,901,902,904,905,907,908,910,911,915,916,920],{},"These parameters are accepted on ",[166,903,191],{},", ",[166,906,195],{},", and ",[166,909,199],{}," endpoints of both ",[180,912,914],{"href":913},"\u002Fguide\u002Fmodels#soft-deletes","standard"," and ",[180,917,919],{"href":918},"\u002Fguide\u002Frelationships#soft-deletes","relation"," resources.",[202,922,923],{"className":204,"code":205,"language":206,"meta":207,"style":207},[166,924,925],{"__ignoreMap":207},[211,926,927,929,931,933,935,937],{"class":213,"line":214},[211,928,218],{"class":217},[211,930,222],{"class":221},[211,932,225],{"class":217},[211,934,228],{"class":221},[211,936,232],{"class":231},[211,938,236],{"class":235},[160,940,942],{"id":941},"force-deleting","Force Deleting",[152,944,945,946,948,949,951,952,915,954,920],{},"Last but not least, the ",[166,947,245],{}," query parameter allows you to permanently delete a resource. The parameter is accepted on the ",[166,950,253],{}," endpoint of both ",[180,953,914],{"href":913},[180,955,919],{"href":918},[202,957,958],{"className":204,"code":256,"language":206,"meta":207,"style":207},[166,959,960],{"__ignoreMap":207},[211,961,962,964,966,968,970,972],{"class":213,"line":214},[211,963,218],{"class":217},[211,965,265],{"class":221},[211,967,225],{"class":217},[211,969,270],{"class":221},[211,971,232],{"class":231},[211,973,236],{"class":235},[156,975,977],{"id":976},"pagination-limit","Pagination Limit",[152,979,980,981,983,984,986,987,989],{},"By default, 15 entities are returned per page from the ",[166,982,191],{}," or ",[166,985,195],{}," endpoints. To customize that, use the ",[166,988,289],{}," method:",[202,991,993],{"className":293,"code":992,"language":295,"meta":207,"style":207},"\u003C?php\n\nnamespace App\\Http\\Controllers\\Api;\n\nuse Orion\\Http\\Controllers\\Controller;\n\nclass PostsController extends Controller\n{\n    ...\n\n    \u002F**\n    * Default pagination limit.\n    *\n    * @return int\n    *\u002F\n    public function limit() : int\n    {\n        return 20;\n    }\n\n    ...\n}\n",[166,994,995,1001,1005,1025,1029,1049,1053,1063,1067,1071,1075,1079,1084,1088,1096,1100,1114,1118,1126,1130,1134,1138],{"__ignoreMap":207},[211,996,997,999],{"class":213,"line":214},[211,998,302],{"class":217},[211,1000,306],{"class":305},[211,1002,1003],{"class":213,"line":309},[211,1004,313],{"emptyLinePlaceholder":312},[211,1006,1007,1009,1011,1013,1015,1017,1019,1021,1023],{"class":213,"line":316},[211,1008,320],{"class":319},[211,1010,323],{"class":221},[211,1012,326],{"class":217},[211,1014,329],{"class":221},[211,1016,326],{"class":217},[211,1018,334],{"class":221},[211,1020,326],{"class":217},[211,1022,339],{"class":221},[211,1024,342],{"class":217},[211,1026,1027],{"class":213,"line":345},[211,1028,313],{"emptyLinePlaceholder":312},[211,1030,1031,1033,1035,1037,1039,1041,1043,1045,1047],{"class":213,"line":350},[211,1032,353],{"class":319},[211,1034,356],{"class":305},[211,1036,326],{"class":217},[211,1038,329],{"class":305},[211,1040,326],{"class":217},[211,1042,334],{"class":305},[211,1044,326],{"class":217},[211,1046,369],{"class":305},[211,1048,342],{"class":217},[211,1050,1051],{"class":213,"line":374},[211,1052,313],{"emptyLinePlaceholder":312},[211,1054,1055,1057,1059,1061],{"class":213,"line":379},[211,1056,383],{"class":382},[211,1058,386],{"class":221},[211,1060,389],{"class":382},[211,1062,392],{"class":221},[211,1064,1065],{"class":213,"line":395},[211,1066,398],{"class":217},[211,1068,1069],{"class":213,"line":401},[211,1070,404],{"class":217},[211,1072,1073],{"class":213,"line":407},[211,1074,313],{"emptyLinePlaceholder":312},[211,1076,1077],{"class":213,"line":412},[211,1078,416],{"class":415},[211,1080,1081],{"class":213,"line":419},[211,1082,1083],{"class":415},"    * Default pagination limit.\n",[211,1085,1086],{"class":213,"line":425},[211,1087,428],{"class":415},[211,1089,1090,1092,1094],{"class":213,"line":431},[211,1091,434],{"class":415},[211,1093,438],{"class":437},[211,1095,441],{"class":437},[211,1097,1098],{"class":213,"line":444},[211,1099,447],{"class":415},[211,1101,1102,1104,1106,1108,1110,1112],{"class":213,"line":450},[211,1103,453],{"class":382},[211,1105,456],{"class":382},[211,1107,459],{"class":235},[211,1109,462],{"class":217},[211,1111,465],{"class":217},[211,1113,441],{"class":319},[211,1115,1116],{"class":213,"line":470},[211,1117,473],{"class":217},[211,1119,1120,1122,1124],{"class":213,"line":476},[211,1121,480],{"class":479},[211,1123,483],{"class":319},[211,1125,342],{"class":217},[211,1127,1128],{"class":213,"line":488},[211,1129,491],{"class":217},[211,1131,1132],{"class":213,"line":494},[211,1133,313],{"emptyLinePlaceholder":312},[211,1135,1136],{"class":213,"line":499},[211,1137,404],{"class":217},[211,1139,1140],{"class":213,"line":504},[211,1141,507],{"class":217},[152,1143,1144,1145,1147],{},"To instruct the API to return a specific number of entities per page, the URL needs to contain the ",[166,1146,289],{}," query parameter.",[202,1149,1150],{"className":204,"code":516,"language":206,"meta":207,"style":207},[166,1151,1152],{"__ignoreMap":207},[211,1153,1154,1156,1158,1160,1162],{"class":213,"line":214},[211,1155,218],{"class":217},[211,1157,222],{"class":221},[211,1159,225],{"class":217},[211,1161,529],{"class":221},[211,1163,532],{"class":231},[534,1165,1166],{},[152,1167,1168,1169,1171,1172,1175,1176,1178,1179,1181],{},"Value specified in the ",[166,1170,289],{}," query parameter ",[542,1173,1174],{},"always"," overwrites the value specified in the ",[166,1177,289],{}," method on a controller, but it can never exceed the value specified in the ",[166,1180,551],{}," method.",[156,1183,1185],{"id":1184},"max-pagination-limit","Max Pagination Limit",[152,1187,1188,1189,989],{},"By default, there is no limit on how many entities could be requested from the API. To customize that, use the ",[166,1190,551],{},[202,1192,1194],{"className":293,"code":1193,"language":295,"meta":207,"style":207},"\u003C?php\n\nnamespace App\\Http\\Controllers\\Api;\n\nuse Orion\\Http\\Controllers\\Controller;\n\nclass PostsController extends Controller\n{\n    ...\n\n    \u002F**\n    * Max pagination limit.\n    *\n    * @return int\n    *\u002F\n    public function maxLimit() : int\n    {\n        return 100;\n    }\n\n    ...\n}\n",[166,1195,1196,1202,1206,1226,1230,1250,1254,1264,1268,1272,1276,1280,1285,1289,1297,1301,1315,1319,1327,1331,1335,1339],{"__ignoreMap":207},[211,1197,1198,1200],{"class":213,"line":214},[211,1199,302],{"class":217},[211,1201,306],{"class":305},[211,1203,1204],{"class":213,"line":309},[211,1205,313],{"emptyLinePlaceholder":312},[211,1207,1208,1210,1212,1214,1216,1218,1220,1222,1224],{"class":213,"line":316},[211,1209,320],{"class":319},[211,1211,323],{"class":221},[211,1213,326],{"class":217},[211,1215,329],{"class":221},[211,1217,326],{"class":217},[211,1219,334],{"class":221},[211,1221,326],{"class":217},[211,1223,339],{"class":221},[211,1225,342],{"class":217},[211,1227,1228],{"class":213,"line":345},[211,1229,313],{"emptyLinePlaceholder":312},[211,1231,1232,1234,1236,1238,1240,1242,1244,1246,1248],{"class":213,"line":350},[211,1233,353],{"class":319},[211,1235,356],{"class":305},[211,1237,326],{"class":217},[211,1239,329],{"class":305},[211,1241,326],{"class":217},[211,1243,334],{"class":305},[211,1245,326],{"class":217},[211,1247,369],{"class":305},[211,1249,342],{"class":217},[211,1251,1252],{"class":213,"line":374},[211,1253,313],{"emptyLinePlaceholder":312},[211,1255,1256,1258,1260,1262],{"class":213,"line":379},[211,1257,383],{"class":382},[211,1259,386],{"class":221},[211,1261,389],{"class":382},[211,1263,392],{"class":221},[211,1265,1266],{"class":213,"line":395},[211,1267,398],{"class":217},[211,1269,1270],{"class":213,"line":401},[211,1271,404],{"class":217},[211,1273,1274],{"class":213,"line":407},[211,1275,313],{"emptyLinePlaceholder":312},[211,1277,1278],{"class":213,"line":412},[211,1279,416],{"class":415},[211,1281,1282],{"class":213,"line":419},[211,1283,1284],{"class":415},"    * Max pagination limit.\n",[211,1286,1287],{"class":213,"line":425},[211,1288,428],{"class":415},[211,1290,1291,1293,1295],{"class":213,"line":431},[211,1292,434],{"class":415},[211,1294,438],{"class":437},[211,1296,441],{"class":437},[211,1298,1299],{"class":213,"line":444},[211,1300,447],{"class":415},[211,1302,1303,1305,1307,1309,1311,1313],{"class":213,"line":450},[211,1304,453],{"class":382},[211,1306,456],{"class":382},[211,1308,679],{"class":235},[211,1310,462],{"class":217},[211,1312,465],{"class":217},[211,1314,441],{"class":319},[211,1316,1317],{"class":213,"line":470},[211,1318,473],{"class":217},[211,1320,1321,1323,1325],{"class":213,"line":476},[211,1322,480],{"class":479},[211,1324,696],{"class":319},[211,1326,342],{"class":217},[211,1328,1329],{"class":213,"line":488},[211,1330,491],{"class":217},[211,1332,1333],{"class":213,"line":494},[211,1334,313],{"emptyLinePlaceholder":312},[211,1336,1337],{"class":213,"line":499},[211,1338,404],{"class":217},[211,1340,1341],{"class":213,"line":504},[211,1342,507],{"class":217},[156,1344,1346],{"id":1345},"aggregating","Aggregating",[152,1348,1349,1350,1354],{},"First, relations and fields used for aggregation need to be ",[180,1351,1353],{"href":1352},"\u002Fguide\u002Fsearch#aggregates","whitelisted",".",[152,1356,1357],{},"To instruct the API to return aggregates, the URL needs to contain a specific query parameter with a comma-separated list of relations or fields.",[202,1359,1360],{"className":204,"code":731,"language":206,"meta":207,"style":207},[166,1361,1362,1374,1386,1398,1410,1422],{"__ignoreMap":207},[211,1363,1364,1366,1368,1370,1372],{"class":213,"line":214},[211,1365,218],{"class":217},[211,1367,222],{"class":221},[211,1369,225],{"class":217},[211,1371,744],{"class":221},[211,1373,747],{"class":231},[211,1375,1376,1378,1380,1382,1384],{"class":213,"line":309},[211,1377,218],{"class":217},[211,1379,222],{"class":221},[211,1381,225],{"class":217},[211,1383,758],{"class":221},[211,1385,747],{"class":231},[211,1387,1388,1390,1392,1394,1396],{"class":213,"line":316},[211,1389,218],{"class":217},[211,1391,222],{"class":221},[211,1393,225],{"class":217},[211,1395,771],{"class":221},[211,1397,774],{"class":231},[211,1399,1400,1402,1404,1406,1408],{"class":213,"line":345},[211,1401,218],{"class":217},[211,1403,222],{"class":221},[211,1405,225],{"class":217},[211,1407,785],{"class":221},[211,1409,774],{"class":231},[211,1411,1412,1414,1416,1418,1420],{"class":213,"line":350},[211,1413,218],{"class":217},[211,1415,222],{"class":221},[211,1417,225],{"class":217},[211,1419,798],{"class":221},[211,1421,774],{"class":231},[211,1423,1424,1426,1428,1430,1432],{"class":213,"line":374},[211,1425,218],{"class":217},[211,1427,222],{"class":221},[211,1429,225],{"class":217},[211,1431,811],{"class":221},[211,1433,774],{"class":231},[156,1435,1437],{"id":1436},"including-relations","Including Relations",[152,1439,1440,1441,1354],{},"First, relations need to be ",[180,1442,1353],{"href":1443},"\u002Fguide\u002Fsearch#includes",[152,1445,1446,1447,1449],{},"To instruct the API to return relations, the URL needs to contain the ",[166,1448,828],{}," query parameter with a comma-separated list of relations.",[202,1451,1452],{"className":204,"code":832,"language":206,"meta":207,"style":207},[166,1453,1454],{"__ignoreMap":207},[211,1455,1456,1458,1460,1462,1464],{"class":213,"line":214},[211,1457,218],{"class":217},[211,1459,222],{"class":221},[211,1461,225],{"class":217},[211,1463,845],{"class":221},[211,1465,747],{"class":231},[849,1467,851],{},{"title":207,"searchDepth":214,"depth":309,"links":1469},[1470,1474,1475,1476,1477],{"id":882,"depth":309,"text":883,"children":1471},[1472,1473],{"id":886,"depth":316,"text":887},{"id":941,"depth":316,"text":942},{"id":976,"depth":309,"text":977},{"id":1184,"depth":309,"text":1185},{"id":1345,"depth":309,"text":1346},{"id":1436,"depth":309,"text":1437},"Learn what query parameters are available and how to utilize them.",{},"\u002Fguide\u002Fquery-parameters",{"title":114,"description":1478},"1.guide\u002F08.query-parameters","idI7WmgOIDM-BwAORdxoSq0ly6t_GFsXf8XTtcVB-FA",1784394466573]