Query Builder API

쿼리 빌더는 AEM의 컨텐츠 저장소를 쉽게 쿼리하는 방법을 제공합니다. 이 기능은 Java API 및 REST API를 통해 노출됩니다. 이 문서에서는 이러한 API에 대해 설명합니다.

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

쿼리 설명은 단순히 설명 집합(Predicate)입니다. 예에는 XPath의 jcr:contains() 함수에 해당하는 전체 텍스트 술어가 포함됩니다.

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

REST API는 JSON에서 보내는 응답과 함께 HTTP를 통해 정확히 동일한 기능에 대한 액세스 권한을 제공합니다.

노트

QueryBuilder API는 JCR API를 사용하여 빌드됩니다. OSGi 번들 내에서 JCR API를 사용하여 AEM JCR을 쿼리할 수도 있습니다. 자세한 내용은 JCR API를 사용하여 Adobe Experience Manager 데이터 쿼리를 참조하십시오.

Gem 세션

AEM Gemsis는 Adobe 전문가가 전달하는 Adobe Experience Manager에 대한 일련의 기술 심층 정보입니다.

쿼리 빌더 전용 세션을 검토하여 도구의 개요 및 사용을 확인할 수 있습니다.

샘플 쿼리

이러한 샘플은 Java 속성 스타일 표기법으로 제공됩니다. Java API와 함께 사용하려면 다음에 나오는 API 샘플에서와 같이 Java HashMap을 사용하십시오.

QueryBuilder JSON 서블릿의 경우, 각 예에는 AEM 설치에 대한 샘플 링크가 포함되어 있습니다(기본 위치: http://<host>:<port>). 이러한 링크를 사용하려면 먼저 AEM 인스턴스에 로그인해야 합니다.

주의

기본적으로 쿼리 빌더 JSON 서블릿은 최대 10개의 히트를 표시합니다.

다음 매개 변수를 추가하면 서블릿이 모든 쿼리 결과를 표시할 수 있습니다.

p.limit=-1

노트

브라우저에서 반환된 JSON 데이터를 보려면 Firefox용 JSONView와 같은 플러그인을 사용할 수 있습니다.

모든 결과 반환

다음 쿼리는 10개의 결과(또는 최대 10개의 히트 수를 정확하게) 반환하지만 실제로 사용할 수 있는 히트 수:​를 알려 줍니다.

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
orderby=path

동일한 쿼리(매개 변수 p.limit=-1 포함)는 모든 결과​를 반환합니다(인스턴스에 따라 높은 숫자가 될 수 있음).

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&orderby=path&p.limit=-1

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
p.limit=-1
orderby=path

p.guessTotal을 사용하여 결과 반환

p.guessTotal 매개 변수의 목적은 최소 실행 가능한 p.offset 값과 p.limit 값을 결합하여 표시할 수 있는 적절한 수의 결과를 반환하는 것입니다. 이 매개 변수를 사용하면 큰 결과 집합을 사용할 때 성능이 개선됩니다. 따라서 전체 합계(예: result.getSize() 호출)를 계산하고 OAK 엔진 및 색인까지 최적화하여 전체 결과 집합을 읽지 않습니다. 실행 시간 및 메모리 사용량 모두 수십만 개의 결과가 있을 때 이러한 차이가 크게 발생할 수 있습니다.

매개 변수에 대한 단점은 사용자가 정확한 합계를 볼 수 없다는 것입니다. 그러나 p.guessTotal=1000과 같은 최소 숫자를 설정하여 항상 최대 1000까지 읽을 수 있으므로 더 작은 결과 집합에 대한 정확한 합계를 얻을 수 있지만, 더 많은 경우 "및 더 많은"만 표시할 수 있습니다.

아래 쿼리에 p.guessTotal=true을(를) 추가하여 어떻게 작동하는지 확인하십시오.

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&p.guessTotal=true&orderby=path

path=/content
1_property=sling:resourceType
1_property.value=wknd/components/structure/page
1_property.operation=like
p.guessTotal=true
orderby=path

쿼리는 0 오프셋이 있는 10p.limit 기본값을 반환합니다.

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

숫자 값을 사용하여 최대 사용자 지정 최대 결과 수를 계산할 수도 있습니다. 위와 동일한 쿼리를 사용하지만 p.guessTotal 값을 50(으)로 변경하십시오.

http://<host>:<port>/bin/querybuilder.json?path=/content&1_property=sling:resourceType&1_property.value=wknd/components/structure/page&1_property.operation=like&p.guessTotal=50&orderby=path

오프셋이 0인 것과 동일한 기본 한계인 10개의 결과를 반환하지만 최대 50개의 결과만 표시됩니다.

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

페이지 매김 구현

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

예를 들어 UI는 다음 방법을 적용할 수 있습니다.

  • 총 히트 수(SearchResult.getTotalMatches() 또는 querybuilder.json 응답의 합계)가 100개 미만이거나 같습니다.

  • 쿼리 빌더를 호출하면서 guessTotal을 100으로 설정합니다.

  • 응답에는 다음 결과가 있을 수 있습니다.

    • total=43, more=false - 총 히트 수가 43개임을 나타냅니다. UI는 첫 번째 페이지의 일부로 최대 10개의 결과를 표시하고 다음 3개 페이지에 대한 페이지 매김을 제공할 수 있습니다. 또한 이 구현을 사용하여 "43개의 결과 발견"​와 같은 설명 텍스트를 표시할 수도 있습니다.
    • total=100, more=true - 총 히트 수가 100개 이상이고 정확한 수를 알 수 없음을 나타냅니다. UI는 첫 번째 페이지의 일부로 최대 10개의 페이지를 표시할 수 있으며 다음 10개의 페이지에 대한 페이지 매김을 제공합니다. 이 옵션을 사용하여 "100개 이상의 결과 발견"​과 같은 텍스트를 표시할 수도 있습니다. 사용자가 쿼리 빌더에 대한 다음 페이지 호출로 이동하면 guessTotaloffsetlimit 매개 변수의 제한이 증가합니다.

guessTotal 쿼리 빌더가 정확한 히트 수를 확인하지 않도록 하기 위해 UI가 무한 스크롤을 사용해야 하는 경우에도 사용해야 합니다.

jar 파일을 찾아 최신 순서대로 정렬합니다.

http://<host>:<port>/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

모든 페이지를 찾아 마지막으로 수정한까지 순서 지정

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&orderby=@jcr:content/cq:lastModified

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

모든 페이지를 찾아 마지막으로 수정한 날짜, 내림차순

http://<host>:<port>/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

전체 텍스트 검색, 점수 순

http://<host>:<port>/bin/querybuilder.json?fulltext=Management&orderby=@jcr:score&orderby.sort=desc

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

특정 태그가 있는 페이지 검색

http://<host>:<port>/bin/querybuilder.json?type=cq:Page&tagid=wknd:activity/cycling&tagid.property=jcr:content/cq:tags

type=cq:Page
tagid=wknd:activity/cycling
tagid.property=jcr:content/cq:tags

명시적 태그 ID를 알고 있는 경우 예에서처럼 tagid 조건자를 사용합니다.

태그 제목 경로(공백 없이)에 tag 조건자를 사용합니다.

이전 예제에서 페이지(cq:Page 노드)를 검색하고 있으므로 해당 노드의 상대 경로를 tagid.property 조건자(예: jcr:content/cq:tags)에 사용해야 합니다. 기본적으로 tagid.property은(는) 단순히 cq:tags입니다.

여러 경로 검색(그룹 사용)

http://<host>:<port>/bin/querybuilder.json?fulltext=Experience&group.1_path=/content/wknd/us/en/magazine&group.2_path=/content/wknd/us/en/adventures&group.p.or=true

fulltext=Experience
group.p.or=true
group.1_path=/content/wknd/us/en/magazine
group.2_path=/content/wknd/us/en/adventures

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

"Experience" and ("/content/wknd/us/en/magazine" or "/content/wknd/us/en/adventures")

예제의 그룹 내에서 path 조건자는 여러 번 사용됩니다. 조건자의 두 인스턴스를 구분하고 순서를 지정하려면(일부 예측자의 경우 순서가 필요함), 조건자의 접두어를 N_으로 붙여야 합니다. 여기서 N은 주문 인덱스입니다. 이전 예에서 결과 예측자는 1_path2_path입니다.

p.orp은 다음과 같은 그룹의 하위 조건자(예: 1_path와 대조되는 경우 매개 변수​임)를 나타내는 특수 구분 기호입니다.or

p.or을(를) 제공하지 않으면 모든 예측자가 함께 ANDed가 됩니다. 즉, 각 결과는 모든 예측자를 만족시켜야 합니다.

노트

하나의 쿼리에 동일한 숫자 접두어를 사용할 수 없으며 서로 다른 예측자에도 사용할 수 없습니다.

속성 검색

여기서 cq:template 속성을 사용하여 지정된 템플릿의 모든 페이지를 검색합니다.

http://<host>:<port>/bin/querybuilder.json?property=cq%3atemplate&property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&type=cq%3aPageContent

type=cq:PageContent
property=cq:template
property.value=/conf/wknd/settings/wcm/templates/adventure-page-template

여기에는 페이지 자체가 아니라 페이지의 jcr:content 노드가 반환되는 단점이 있습니다. 이 문제를 해결하려면 상대 경로로 검색할 수 있습니다.

http://<host>:<port>/bin/querybuilder.json?property=jcr%3acontent%2fcq%3atemplate&property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&type=cq%3aPage

type=cq:Page
property=jcr:content/cq:template
property.value=/conf/wknd/settings/wcm/templates/adventure-page-template

여러 속성 검색

속성 조건자를 여러 번 사용할 때는 번호 접두어를 다시 추가해야 합니다.

http://<host>:<port>/bin/querybuilder.json?1_property=jcr%3acontent%2fcq%3atemplate&1_property.value=%2fconf%2fwknd%2fsettings%2fwcm%2ftemplates%2fadventure-page-template&2_property=jcr%3acontent%2fjcr%3atitle&2_property.value=Cycling%20Tuscany&type=cq%3aPage

type=cq:Page
1_property=jcr:content/cq:template
1_property.value=/conf/wknd/settings/wcm/templates/adventure-page-template
2_property=jcr:content/jcr:title
2_property.value=Cycling Tuscany

여러 속성 값 검색

속성("A" or "B" or "C")의 여러 값을 검색할 때 큰 그룹을 피하려면 property 조건자에 여러 값을 제공할 수 있습니다.

http://<host>:<port>/bin/querybuilder.json?property=jcr%3atitle&property.1_value=Cycling%20Tuscany&property.2_value=Ski%20Touring&property.3_value=Whistler%20Mountain%20Biking

property=jcr:title
property.1_value=Cycling Tuscany
property.2_value=Ski Touring
property.3_value=Whistler Mountain Biking

다중 값 속성의 경우 여러 값이 일치해야 합니다("A" and "B" and "C").

http://<host>:<port>/bin/querybuilder.json?property=jcr%3atitle&property.and=true&property.1_value=Cycling%20Tuscany&property.2_value=Ski%20Touring&property.3_value=Whistler%20Mountain%20Biking

property=jcr:title
property.and=true
property.1_value=Cycling Tuscany
property.2_value=Ski Touring
property.3_value=Whistler Mountain Biking

반환되는 항목 수정

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

지정

p.hits=full

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

http://<host>:<port>/bin/querybuilder.json?p.hits=full&property=jcr%3atitle&property.value=Cycling%20Tuscany

property=jcr:title
property.value=Cycling Tuscany
p.hits=full

사용

p.hits=selective

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

p.properties

공백으로 구분:

http://<host>:<port>/bin/querybuilder.json?p.hits=selective&p.properties=sling%3aresourceType%20jcr%3aprimaryType&property=jcr%3atitle&property.value=Cycling%20Tuscany

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

쿼리 빌더 응답에 하위 노드를 포함할 수도 있습니다. 이렇게 하려면

p.nodedepth=n

여기서 n은 쿼리를 반환할 수준 수입니다. 자식 노드를 반환하려면 속성 선택기로 지정해야 합니다

p.hits=full

예:

http://<host>:<port>/bin/querybuilder.json?p.hits=full&p.nodedepth=5&property=jcr%3atitle&property.value=Cycling%20Tuscany

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

추가 설명

추가 설명을 보려면 쿼리 빌더 설명 참조 페이지를 참조하십시오.

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

클래스 이름의 접두어(예: SimilarityPredicateEvaluatorsimilar)는 클래스의 principal 속성​입니다. 이 속성은 쿼리에 사용할 조건자 이름이기도 합니다(소문자 구분).

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

쿼리 빌더 API 사용 예

   String fulltextSearchTerm = "WKND";

    // 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://<host>:<port>/bin/querybuilder.json?path=/content&type=cq:Page&group.p.or=true&group.1_fulltext=WKND&group.1_fulltext.relPath=jcr:content&group.2_fulltext=WKND&group.2_fulltext.relPath=jcr:content/@cq:tags&p.offset=0&p.limit=20

쿼리 저장 및 로드 중

나중에 사용할 수 있도록 쿼리를 저장소에 저장할 수 있습니다. QueryBuilder은 다음 서명을 사용하여 storeQuery 메서드를 제공합니다.

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

QueryBuilder#storeQuery 메서드를 사용할 때 주어진 QuerycreateFile 인수 값에 따라 보관소에 파일이나 속성으로 저장됩니다. 다음 예제에서는 Query을 경로 /mypath/getfiles에 파일로 저장하는 방법을 보여 줍니다.

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

이전에 저장한 모든 쿼리는 QueryBuilder#loadQuery 메서드를 사용하여 저장소에서 로드할 수 있습니다.

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

예를 들어 /mypath/getfiles 경로에 저장된 Query은 다음 코드 단편으로 로드할 수 있습니다.

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

테스트 및 디버깅

쿼리 빌더 쿼리를 재생하고 디버깅하려면

http://<host>:<port>/libs/cq/search/content/querydebug.html

또는 쿼리 빌더 JSON 서블릿(

http://<host>:<port>/bin/querybuilder.json?path=/tmp

path=/tmp 은 예일 뿐입니다.

일반 디버깅 Recommendations

로깅을 통해 설명 가능한 XPath 가져오기

대상 인덱스 집합에 대해 개발 주기 동안 모든 쿼리를 설명합니다.

  1. QueryBuilder에 대한 DEBUG 로그를 사용하여 실행 가능한 기본 XPath 쿼리를 얻습니다.
    • 다음으로 이동 https://<host>:<port>/system/console/slinglog. DEBUG​에서 com.day.cq.search.impl.builder.QueryImpl에 대한 새 로거를 만듭니다.
  2. 위의 클래스에 대해 DEBUG가 활성화되면 로그는 Query Builder에서 생성한 XPath를 표시합니다.
  3. 연결된 쿼리 빌더 쿼리에 대한 로그 항목의 XPath 쿼리를 복사합니다. 예:
    • com.day.cq.search.impl.builder.QueryImpl XPath query: /jcr:root/content//element(*, cq:Page)[(jcr:contains(jcr:content, "WKND") or jcr:contains(jcr:content/@cq:tags, "WKND"))]
  4. 쿼리 계획을 얻으려면 XPath 쿼리를 XPath로 설명하십시오.

쿼리 빌더 디버거를 통해 설명 가능한 XPath 가져오기

AEM Query Builder 디버거를 사용하여 설명 가능한 XPath 쿼리를 생성합니다.

쿼리 빌더 디버거

  1. 쿼리 빌더 디버거에 쿼리 빌더 쿼리 제공
  2. 검색 실행
  3. 생성된 XPath 가져오기
  4. 쿼리 계획을 얻으려면 XPath 쿼리를 XPath로 설명하십시오.
노트

쿼리 작성기 이외의 쿼리 쿼리(XPath, JCR-SQL2)는 쿼리 설명에 직접 제공할 수 있습니다.

로깅으로 쿼리 디버깅

노트

로거 구성은 로깅 문서에 설명되어 있습니다.

이전 섹션 테스트 및 디버깅:에 설명된 쿼리를 실행할 때 쿼리 빌더 구현의 로그 출력(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=WKND, relPath=jcr:content}
        {2_fulltext=fulltext: fulltext=WKND, 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, "WKND") or jcr:contains(jcr:content/@cq:tags, "WKND"))]
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 설명
com.day.cq.search 기본 쿼리 빌더 및 쿼리 API
com.day.cq.search.result 결과 API
com.day.cq.search.facets 패싯
com.day.cq.search.facets.bucks 버킷(패싯 내에 포함)
com.day.cq.search.eval 설명 평가자
com.day.cq.search.facets.extractor 패싯 추출기(평가자용)
com.day.cq.search.writer 쿼리 빌더 서블릿용 JSON 결과 히트 기록기(/bin/querybuilder.json)

이 페이지에서는

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now