쿼리 빌더 API query-builder-api

의 기능 자산 공유 쿼리 빌더 는 Java API 및 REST API를 통해 노출됩니다. 이 섹션에서는 이러한 API에 대해 설명합니다.

서버측 쿼리 빌더( QueryBuilder)은 쿼리 설명을 적용하고, XPath 쿼리를 만들고 실행하고, 원하는 경우 결과 세트를 필터링하고, 패싯도 추출합니다.

쿼리 설명은 단순히 설명 집합입니다(Predicate). 예로는 jcr:contains() 함수 내에 있어야 합니다.

각 설명 유형에 대해 평가기 구성 요소(PredicateEvaluator) XPath, 필터링 및 패싯 추출에 대한 특정 설명을 처리하는 방법을 알고 있습니다. OSGi 구성 요소 런타임을 통해 플러그인이 되는 사용자 정의 평가자를 만드는 것은 매우 쉽습니다.

REST API는 JSON으로 전송되는 응답을 사용하여 HTTP를 통해 정확히 동일한 기능에 대한 액세스 권한을 제공합니다.

Gem 세션 gem-session

AEM Gems 는 Adobe 전문가가 제공하는 Adobe Experience Manager에 대한 일련의 기술적인 분석입니다. 쿼리 빌더에 전용 이 세션은 도구의 개요 및 사용에 매우 유용합니다.

샘플 쿼리 sample-queries

이러한 샘플은 Java 속성 스타일 표기법으로 제공됩니다. Java API에서 사용하려면 Java를 사용하십시오 HashMap 를 설정하는 것이 좋습니다.

대상 QueryBuilder JSON 서블릿, 각 예에는 로컬 CQ 설치(기본 위치: http://localhost:4502). 이 링크를 사용하려면 먼저 CQ 인스턴스에 로그인해야 합니다.

모든 결과 반환 returning-all-results

다음 쿼리는 10개의 결과 반환 (또는 최대 10개까지 정밀하게) 히트 수: 실제로 사용 가능한 사항:

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
orderby=path

동일한 쿼리(매개 변수 사용) p.limit=-1) 모든 결과 반환 (인스턴스에 따라 숫자가 높을 수 있습니다.)

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.limit=-1&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.limit=-1
orderby=path

p.guessTotal을 사용하여 결과 반환 using-p-guesstotal-to-return-the-results

의 목적 p.guessTotal 매개 변수는 최소 실행 가능한 p.offset 및 p.limit 값을 결합하여 표시할 수 있는 적절한 결과 수를 반환하는 것입니다. 이 매개 변수를 사용하면 큰 결과 세트를 사용하여 성능이 향상됩니다. 따라서 전체 합계(예: result.getSize() 호출)를 계산하고 OAK 엔진 및 인덱스로 끝까지 최적화되어 전체 결과 세트를 읽지 않습니다. 이 기능은 실행 시간과 메모리 사용 모두에서 100,000개의 결과가 있을 때 큰 차이가 될 수 있습니다.

매개 변수의 단점은 사용자가 정확한 합계를 보지 못한다는 것입니다. 그러나 p.guessTotal=1000과 같은 최소 수를 설정할 수 있으므로 항상 최대 1000까지 읽게 되므로 더 작은 결과 세트에 대한 정확한 합계를 얻을 수 있지만, 그 이상일 경우 "및"만 표시할 수 있습니다.

추가 p.guessTotal=true 아래 쿼리를 클릭하여 작동 방식을 확인합니다.

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=foundation/components/text
1_property.operation=like
p.guessTotal=true
orderby=path

쿼리는 p.limit 기본값 10 결과 0 offset:

"success": true,
"results": 10,
"total": 10,
"more": true,
"offset": 0,

AEM 6.0 SP2부터는 숫자 값을 사용하여 최대 사용자 지정 최대 결과 수를 계산할 수도 있습니다. 위와 동일한 쿼리를 사용하지만 값을 변경합니다. p.guessTotal to 50:

http://localhost:4502/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=foundation/components/text&1_property.operation=like&p.guessTotal=50&orderby=path

오프셋은 0이고, 기본 제한인 10개의 결과에 동일한 숫자가 반환되지만, 최대 50개의 결과만 표시됩니다.

"success": true,
"results": 10,
"total": 50,
"more": true,
"offset": 0,

페이지 매김 구현 implementing-pagination

기본적으로 Query Builder 는 히트 수도 제공합니다. 결과 크기에 따라 정확한 카운트를 결정하는 데 액세스 제어의 모든 결과를 확인하는 데 시간이 오래 걸릴 수 있습니다. 대부분 합계는 최종 사용자 UI에 대한 페이지 매김을 구현하는 데 사용됩니다. 정확한 개수를 결정하려면 guessTotal 기능을 사용하여 페이지 매김을 구현하는 것이 좋습니다.

예를 들어 UI는 다음 접근 방식을 조정할 수 있습니다.

guessTotal Query Builder가 정확한 히트 수를 확인하지 않도록 UI에서 무한 스크롤을 사용해야 하는 경우에도 사용해야 합니다.

jar 파일을 찾아 가장 먼저 순서를 지정합니다 find-jar-files-and-order-them-newest-first

http://localhost:4502/bin/querybuilder.json?type=nt:file&nodename=*.jar&orderby=@jcr:content/jcr:lastModified&orderby.sort=desc

type=nt:file
nodename=*.jar
orderby=@jcr:content/jcr:lastModified
orderby.sort=desc

모든 페이지를 찾아 마지막으로 수정한 순서대로 정렬합니다 find-all-pages-and-order-them-by-last-modified

http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

type=cq:Page
orderby=@jcr:content/cq:lastModified

모든 페이지를 찾아 마지막으로 수정한 후 내림차순으로 정렬합니다 find-all-pages-and-order-them-by-last-modified-but-descending

http://localhost:4502/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified&orderby.sort=desc]

type=cq:Page
orderby=@jcr:content/cq:lastModified
orderby.sort=desc

전체 텍스트 검색, 점수로 정렬됨 fulltext-search-ordered-by-score

http://localhost:4502/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

fulltext=Management
orderby=@jcr:score
orderby.sort=desc

특정 태그가 지정된 페이지 검색 search-for-pages-tagged-with-a-certain-tag

http://localhost:4502/bin/querybuilder.json?type=cq:Page&tagid=marketing:interest/product&tagid.property=jcr:content/cq:tags

type=cq:Page
tagid=marketing:interest/product
tagid.property=jcr:content/cq:tags

를 사용하십시오 tagid 는 명시적 태그 ID를 알고 있는 경우 예와 같이 술어를 제공합니다.

를 사용하십시오 tag 태그 제목 경로 설명(공백 없음).

이전 예에서 페이지( cq:Page nodes) 를 사용하려면 해당 노드의 상대 경로를 tagid.property 조건자 jcr:content/cq:tags. 기본적으로 tagid.property 단지 cq:tags.

여러 경로에서 검색(그룹 사용) search-under-multiple-paths-using-groups

http://localhost:4502/bin/querybuilder.json?fulltext=Management&group.1_path=/content/geometrixx/en/company/management&group.2_path=/content/geometrixx/en/company/bod&group.p.or=true

fulltext=Management
group.p.or=true
group.1_path=/content/geometrixx/en/company/management
group.2_path=/content/geometrixx/en/company/bod

이 쿼리는 그룹 이름이 " group") 괄호가 더 표준 표기법에서 하는 것처럼 쿼리 내에서 하위 표현식을 구분하는 데 사용됩니다. 예를 들어 이전 쿼리는 다음과 같이 더 친숙한 스타일로 표시될 수 있습니다.

"Management" and ("/content/geometrixx/en/company/management" or "/content/geometrixx/en/company/bod")

예제의 그룹 내에서는 path 조건부가 여러 번 사용됩니다. 조건자의 두 인스턴스를 구분하고 순서를 지정하려면(일부 조건자에 대해 순서 지정이 필요) 조건자에 접두사를 붙여야 합니다 N _ whereN 는 주문 색인입니다. 이전 예에서 결과 조건자는 다음과 같습니다 1_path 및 2_path.

다음 p in p.or 는 다음 항목을 나타내는 특수 구분 기호입니다(이 경우 or)은 매개 변수 그룹의 하위 조건자가 아니라 1_path.

없는 경우 p.or 이 지정되면 모든 조건자가 ANDed를 함께 사용합니다. 즉, 각 결과는 모든 조건자를 만족해야 합니다.

속성 검색 search-for-properties

여기서는 다음을 사용하여 주어진 템플릿의 모든 페이지를 검색합니다 cq:template 속성:

http://localhost:4502/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/apps/geometrixx/templates/homepage

이것은 jcr:content 페이지 자체가 아니라 페이지의 노드가 반환됩니다. 이를 해결하기 위해 상대 경로별로 검색할 수 있습니다.

http://localhost:4502/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/apps/geometrixx/templates/homepage

여러 속성 검색 search-for-multiple-properties

속성 설명을 여러 번 사용하는 경우 번호 접두사를 다시 추가해야 합니다.

http://localhost:4502/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fapps%2fgeometrixx%2ftemplates%2fhomepage&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=English&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/apps/geometrixx/templates/homepage
2_property=jcr:content/jcr:title
2_property.value=English

여러 속성 값을 검색합니다 search-for-multiple-property-values

속성( "A" or "B" or "C")를 채울 수도 있고, property 설명:

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Products&property.2_value=Square&property.3_value=Events

property=jcr:title
property.1_value=Products
property.2_value=Square
property.3_value=Events

다중 값 속성의 경우 여러 값이 일치하는지( "A" and "B" and "C"):

http://localhost:4502/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=test&property.2_value=foo&property.3_value=bar

property=jcr:title
property.and=true
property.1_value=test
property.2_value=foo
property.3_value=bar

반환되는 항목 세분화하기 refining-what-is-returned

기본적으로 QueryBuilder JSON 서블릿은 검색 결과의 각 노드(예: 경로, 이름, 제목 등)에 대한 기본 속성 세트를 반환합니다. 반환되는 속성을 제어하려면 다음 중 하나를 수행할 수 있습니다.

지정

p.hits=full

이 경우 각 노드에 대해 모든 속성이 포함됩니다.

http://localhost:4502/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=full

사용

p.hits=selective

그리고 가져올 속성을 지정합니다

p.properties

공백으로 구분:

http://localhost:4502/bin/querybuilder.json?p.hits=selective&property=jcr%3atitle&property.value=Triangle

http://localhost:4502/bin/querybuilder.json? p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3attile&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=selective
p.properties=sling:resourceType jcr:primaryType

QueryBuilder 응답에 하위 노드를 포함할 수도 있습니다. 이를 수행하려면 다음을 지정해야 합니다

p.nodedepth=n

여기서 n 은 쿼리에서 반환할 레벨 수입니다. 하위 노드를 반환하려면 속성 선택기에서 지정해야 합니다

p.hits=full

예:

http://localhost:4502/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Triangle

property=jcr:title
property.value=Triangle
p.hits=full
p.nodedepth=5

추가 설명 morepredicates

자세한 내용은 Query Builder 설명 참조 페이지.

또한 용 Javadoc PredicateEvaluator 클래스. 이러한 클래스의 Javadoc에는 사용할 수 있는 속성 목록이 포함되어 있습니다.

클래스 이름의 접두사(예: " similar" SimilarityPredicateEvaluator)은 주체 Adobe Social이 사용자 ID로 분류되지 않습니다. 이 속성은 쿼리에 사용할 조건자의 이름이기도 합니다(소문자는).

이러한 주체 속성의 경우 쿼리를 줄이고 " similar=/content/en" 대신 " similar.similar=/content/en". 정규화된 양식은 클래스의 모든 비주체 속성에 사용해야 합니다.

Query Builder API 사용 예 example-query-builder-api-usage

   String fulltextSearchTerm = "Geometrixx";

    // create query description as hash map (simplest way, same as form post)
    Map<String, String> map = new HashMap<String, String>();

// create query description as hash map (simplest way, same as form post)
    map.put("path", "/content");
    map.put("type", "cq:Page");
    map.put("group.p.or", "true"); // combine this group with OR
    map.put("group.1_fulltext", fulltextSearchTerm);
    map.put("group.1_fulltext.relPath", "jcr:content");
    map.put("group.2_fulltext", fulltextSearchTerm);
    map.put("group.2_fulltext.relPath", "jcr:content/@cq:tags");

    // can be done in map or with Query methods
    map.put("p.offset", "0"); // same as query.setStart(0) below
    map.put("p.limit", "20"); // same as query.setHitsPerPage(20) below

    Query query = builder.createQuery(PredicateGroup.create(map), session);
    query.setStart(0);
    query.setHitsPerPage(20);

    SearchResult result = query.getResult();

    // paging metadata
    int hitsPerPage = result.getHits().size(); // 20 (set above) or lower
    long totalMatches = result.getTotalMatches();
    long offset = result.getStartIndex();
    long numberOfPages = totalMatches / 20;

    //Place the results in XML to return to client
    DocumentBuilderFactory factory =     DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = factory.newDocumentBuilder();
    Document doc = builder.newDocument();

    //Start building the XML to pass back to the AEM client
    Element root = doc.createElement( "results" );
    doc.appendChild( root );

    // iterating over the results
    for (Hit hit : result.getHits()) {
       String path = hit.getPath();

      //Create a result element
      Element resultel = doc.createElement( "result" );
      root.appendChild( resultel );

      Element pathel = doc.createElement( "path" );
      pathel.appendChild( doc.createTextNode(path ) );
      resultel.appendChild( pathel );
    }

JSON(Query Builder) 서블릿을 사용하여 HTTP를 통해 실행된 동일한 쿼리:

http://localhost:4502/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=Geometrixx&group.1_fulltext.relPath=jcr:content&group.2_fulltext=Geometrixx&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20

쿼리 저장 및 로드 storing-and-loading-queries

쿼리는 나중에 사용할 수 있도록 저장소에 저장할 수 있습니다. 다음 QueryBuilder 는 " storeQuery 다음 서명이 있는 메서드:

void storeQuery(Query query, String path, boolean createFile, Session session) throws RepositoryException, IOException;

를 사용할 때 QueryBuilder#storeQuery 메서드, 지정된 Query 는 저장소에 createFile 인수 값. 다음 예제는 Query 경로 /mypath/getfiles 로서의 파일:

builder.storeQuery(query, "/mypath/getfiles", true, session);

이전에 저장된 쿼리는 QueryBuilder#loadQuery 메서드:

Query loadQuery(String path, Session session) throws RepositoryException, IOException

예: Query 경로에 저장 /mypath/getfiles 다음 코드 조각에 의해 로드될 수 있습니다.

Query loadedQuery = builder.loadQuery("/mypath/getfiles", session);

테스트 및 디버깅 testing-and-debugging

QueryBuilder 쿼리 주위에 재생하고 디버깅하기 위해

http://localhost:4502/libs/cq/search/content/querydebug.html

또는 querybuilder json 서블릿()을

http://localhost:4502/bin/querybuilder.json?path=/tmp

( path=/tmp 는 예일 뿐입니다.

일반 디버깅 Recommendations general-debugging-recommendations

로깅을 통해 설명 가능한 XPath 획득 obtain-explain-able-xpath-via-logging

설명 모두 대상 인덱스 세트에 대한 개발 주기 동안 질의합니다.

Query Builder 디버거를 통해 설명 가능한 XPath 가져오기 obtain-explain-able-xpath-via-the-query-builder-debugger

설명 모두 대상 인덱스 세트에 대한 개발 주기 동안 질의합니다.

로깅을 통해 설명 가능한 XPath 획득

Query Builder 디버거를 통해 설명 가능한 XPath 가져오기

QueryBuilder를 사용하여 쿼리를 디버깅하는 방법에 대한 런다운은 아래 비디오를 참조하십시오.

로깅을 사용하여 쿼리 디버깅 debugging-queries-with-logging

테스트 및 디버깅에 설명된 쿼리를 실행할 때 쿼리 빌더 구현의 로그 출력(INFO 수준)입니다.

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: limit=20, offset=0[
    {group=group: or=true[
        {1_fulltext=fulltext: fulltext=Geometrixx, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=Geometrixx, relPath=jcr:content/@cq:tags}
    ]}
    {path=path: path=/content}
    {type=type: type=cq:Page}
]
com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "Geometrixx") or jcr:contains(jcr:content/@cq:tags, "Geometrixx"))]
com.day.cq.search.impl.builder.QueryImpl no filtering predicates
com.day.cq.search.impl.builder.QueryImpl query execution took 69 ms

비교기로 사용자 지정 순서를 사용하는 조건자 평가자를 사용하여 쿼리가 있거나 비교기를 사용하여 필터링된 경우 이 값이 쿼리에 기록됩니다.

com.day.cq.search.impl.builder.QueryImpl executing query (predicate tree):
null=group: [
    {nodename=nodename: nodename=*.jar}
    {orderby=orderby: orderby=@jcr:content/jcr:lastModified}
    {type=type: type=nt:file}
]
com.day.cq.search.impl.builder.QueryImpl custom order by comparator: jcr:content/jcr:lastModified
com.day.cq.search.impl.builder.QueryImpl XPath query: //element(*, nt:file)
com.day.cq.search.impl.builder.QueryImpl filtering predicates: {nodename=nodename: nodename=*.jar}
com.day.cq.search.impl.builder.QueryImpl query execution took 272 ms

Javadoc 링크 javadoc-links