1

我正在使用 Roxy 来管理我的项目。也使用 MarkLogic 8.0-6.1

我正在尝试提交一个 searchTerm,并返回一个自定义格式search:snippet

以下是我正在采取的完整步骤:

./../roxy/ml new test-app --server-version=8 --app-type=rest

配置我的 build.properties

cd test-app/ ./ml local bootstrap

现在我有了我的项目结构。

创建文件 - test-app/rest-api/ext/show-search.xqy

xquery version "1.0-ml";

module namespace ss = "http://marklogic.com/rest-api/resource/show-search";
import module namespace search = "http://marklogic.com/appservices/search" at "/MarkLogic/appservices/search/search.xqy";
import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/json/json.xqy";




declare
function ss:get(
  $context as map:map,
  $params  as map:map
) as document-node()*
{

  map:put($context, "output-types", "application/json"),
  map:put($context, "output-status", (200, "OK")),

  let $search-term := map:get($params, "searchTerm")
  let $query := search:search($search-term,
      <options xmlns="http://marklogic.com/appservices/search">
        <transform-results apply="raw"/>
      </options>
      )

  return document {$query} 
};

(:
 :)
declare 
function ss:put(   
    $context as map:map,
    $params  as map:map,
    $input   as document-node()*
) as document-node()?
{
  map:put($context, "output-types", "application/xml"),
  map:put($context, "output-status", (201, "Created")),
  document { "PUT called on the ext service extension" }
};

(:
 :)
declare 
function ss:post(
    $context as map:map,
    $params  as map:map,
    $input   as document-node()*
) as document-node()*
{
  map:put($context, "output-types", "application/xml"),
  map:put($context, "output-status", (201, "Created")),
  document { "POST called on the ext service extension" }
};

(:
 :)
declare 
function ss:delete(
    $context as map:map,
    $params  as map:map
) as document-node()?
{
  map:put($context, "output-types", "application/xml"),
  map:put($context, "output-status", (200, "OK")),
  document { "DELETE called on the ext service extension" }
};

上面的 GET 请求transform-results apply=raw正确使用了选项、部署和功能(我有一些测试文档)。

但是我不想返回整个文档,我想返回匹配的整个 json 部分,无论匹配发生在那个部分的哪个位置(较低级别)

所以我尝试自己写snipper

创建文件 - test-app/rest-api/ext/show-search-snipper.xqy

xquery version "1.0-ml";

module namespace sss = "http://marklogic.com/rest-api/resource/show-search-snipper";
import module namespace search = "http://marklogic.com/appservices/search" at "/MarkLogic/appservices/search/search.xqy";
import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/json/json.xqy";

declare
function sss:my-snippet(
    $result as node(),
    $ctsquery as schema-element(cts:query),
    $options as element(search:transform-results)?
) as element(search:snippet)
{
    <search:snippet>

    </search:snippet>
};

然后我将调用更新search:search为以下内容

  let $query := search:search($search-term,
      <options xmlns="http://marklogic.com/appservices/search">
        <transform-results apply="my-snippet" ns="http://marklogic.com/rest-api/resource/show-search-snipper" at="show-search-snipper.xqy"/>
      </options>
      )

现在我应该拥有我需要的一切(我认为)

我运行部署./ml local deploy rest

并得到以下

Minty-linux test-app # ./ml local deploy rest 在 /opt/this-is-a-test/test-app/rest-api/config/properties.xml 中加载 REST 属性 在 /opt/this- 中加载 REST 选项is-a-test/test-app/rest-api/config/options

从 /opt/this-is-a-test/test-app/rest-api/ext 加载 REST 扩展

错误:400“错误请求”错误:{“errorResponse”:{“statusCode”:400,“status”:“错误请求”,“messageCode”:“RESTAPI-INVALIDCONTENT”,“消息”:“RESTAPI-INVALIDCONTENT:( err:FOER0000) 无效内容:无效的 show-search-snipper 扩展:show-search-snipper 不是有效模块,或者在 http://marklogic.com中不提供扩展功能(删除、获取、放置、发布) /rest-api/resource/show-search-snipper 命名空间"}}

所以我尝试将show-search-snipper.xqy文件上移 1 级(到 test-app/rest-api/show-search-snipper.xqy`

运行部署 Deployment Works 没有错误 点击 URL 并收到以下信息

500 内部服务器错误 INTERNAL ERROR RESTAPI-INVALIDREQ: (err:FOER0000) 无效请求:原因:扩展显示搜索不存在。. 有关详细信息,请参阅 MarkLogic 服务器错误日志。

虽然我知道扩展程序是正确创建的,但在引入自定义 snip 功能之前它运行良好。(应用=“原始”)

有什么想法可以应用我的自定义剪辑功能或我在部署中做错了什么?


在此处输入图像描述

4

2 回答 2

1

如果您决定坚持使用自定义代码片段:

看起来 Roxy 正试图将您的代码片段模块视为资源扩展,但事实并非如此。您的代码片段应该只是模块数据库中的一个普通模块。

不幸的是,IDK 如何配置 Roxy,但您的目标是让 RoxyPUT /v1/ext/directories/asset在您的模块数据库上使用或直接插入(`PUT /v1/documents)安装它。请参阅http://docs.marklogic.com/REST/PUT/v1/ext/[directories]/[asset]

假设 Roxy 使用 /ext,那么您的代码片段的路径将不会是您在选项中拥有的非限定路径。这将是一个根植于 /ext/ 的绝对路径。请参阅http://docs.marklogic.com/guide/rest-dev/search#id_72390

于 2017-02-18T16:58:48.693 回答
0

有一种更简单的方法——您可以使用extract-document-data搜索选项来做到这一点。

我设置了一些示例数据来使用,如下所示:

xquery version "1.0-ml";

for $i in (1 to 10)
return 
  xdmp:document-insert(
    '/test-content-' || $i || '.json',
    xdmp:unquote('{ "important": { "foo": 1, "bar": 2 }, "not-important": { "stuff": 3, "blah": 4 } }')
  )

引导和部署模块后,我可以在http://localhost:8040/v1/search获得搜索结果。但是,我可以通过使用存储的搜索选项开始对搜索结果进行更多控制。在您的项目中查看rest-api/config/options/all.xml. 它们在您运行时已经为您部署好了ml local deploy modules,因此您现在可以使用http://localhost:8040/v1/search?options=all进行搜索。由于您使用的是 JSON 数据,因此我更进一步并运行:http://localhost:8040/v1/search?format=json&options=all

我将此添加到rest-api/config/options/all.xml

<extract-document-data selected="include">
  <extract-path>/important</extract-path>
</extract-document-data>

这告诉搜索选项在所有搜索结果中包含指定的路径。再次部署并运行搜索后,一个结果如下所示:

{
  "index":1, 
  "uri":"/test-content-6.json", 
  "path":"fn:doc(\"/test-content-6.json\")", 
  "score":0, 
  "confidence":0, 
  "fitness":0, 
  "href":"/v1/documents?uri=%2Ftest-content-6.json", 
  "mimetype":"application/json", 
  "format":"json", 
  "matches":[{"path":"fn:doc(\"/test-content-6.json\")/object-node()", "match-text":[]}], 
  "extracted":{
    "kind":"array", 
    "content":[
      {"important":{"foo":1, "bar":2}}
    ]
  }
}, 

请注意最后的“提取”部分——我得到了选项中指定的“重要”JSON 属性。

有关可以设置为控制搜索的选项的完整列表,请参阅查询选项参考附录

于 2017-02-17T20:37:18.357 回答