lib-xquery 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34794110980/FIN+5.3.1+lib-xquery 中文整理基于 FIN 5.3.1

导读： XQuery 支持模块

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

---

目录（导读）

• lib
• meta
• funcs
• views
• def
• xq(opts: null)
  • supertypes
• xqDefine(xq, name, val)
• xqEval(xq, expr)
• xqExecute(xq)
• xqFindAll(xq, expr)
• xqFlatMap(xq, expr)
• xqHisRead(xq, span, opts: null)
• xqHisRollup(xq, fold, interval)
• xqHisRollupAuto(xq, interval: null)
• xqMap(xq, expr)
• xqPivot(xq, shape)
• xqProjs(xq, names)
• xqReadAll(xq, filter, opts: null)
• xqReadAllList(xq, filter, opts: null)
• xqReadByIds(xq, ids)
• xqReadByIdsList(xq, ids)
• xqTimeout(xq, val)
• xqTrace(xq)
• xqUseReplicas(xq, val: true)
  • src

---

概述（中译）

XQuery 支持模块

---

API 正文（英文）

funcs

xq	Construct new XQuery instance
xqDefine	Define a variable available to subsequent Axon expressions
xqEval	Evaluate an Axon expr in each project - see XQuery.eval
xqExecute	Execute the XQuery and return results
xqFindAll	Filter the previous step using an Axon expr - see XQuery.findAll
xqFlatMap	Map the previous step to zero or more Dicts using an Axon expr - see XQuery.flatMap
xqHisRead	Read point history data - see XQuery.hisRead
xqHisRollup	Rollup history data - see XQuery.hisRollup
xqHisRollupAuto	Rollup history data - see XQuery.hisRollupAuto
xqMap	Map the previous step using an Axon expr - see XQuery.map
xqPivot	Transform previous step into pivot table - see XQuery.pivot Note
xqProjs	Restrict query to given project name(s) - see XQuery.projs
xqReadAll	Read recs by filter - see XQuery.readAll
xqReadAllList	Read recs by filter - see XQuery.readAllList
xqReadByIds	Read recs by ids - see XQuery.readByIds
xqReadByIdsList	Read recs by ids - see XQuery.readByIds
xqTimeout	Set timeout for network calls to remote nodes - see XQuery.timeout
xqTrace	Execute the XQuery and return debug tracing
xqUseReplicas	Route to replicas instead of master - see XQuery.useReplicas

---

views

xquerySettings	Settings for the XQuery system module

---

---

def

func:xq

xq(opts: null)

Construct new XQuery instance. Options:

• timeout: timeout to use for network calls to remote nodes
• useReplicas: marker tag to enable replica reads

---

meta

def	func:xq
is	func
lib	lib:xquery
name	xq

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqDefine

xqDefine(xq, name, val)

Define a variable available to subsequent Axon expressions. This provides an easy way to marshall data across the cluster without encoding data to an Axon expression. See XQuery.define.

---

meta

def	func:xqDefine
is	func
lib	lib:xquery
name	xqDefine

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqEval

xqEval(xq, expr)

Evaluate an Axon expr in each project - see XQuery.eval

---

meta

def	func:xqEval
is	func
lib	lib:xquery
name	xqEval

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqExecute

xqExecute(xq)

Execute the XQuery and return results

---

meta

def	func:xqExecute
is	func
lib	lib:xquery
name	xqExecute

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqFindAll

xqFindAll(xq, expr)

Filter the previous step using an Axon expr - see XQuery.findAll

---

meta

def	func:xqFindAll
is	func
lib	lib:xquery
name	xqFindAll

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqFlatMap

xqFlatMap(xq, expr)

Map the previous step to zero or more Dicts using an Axon expr - see XQuery.flatMap

---

meta

def	func:xqFlatMap
is	func
lib	lib:xquery
name	xqFlatMap

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqHisRead

xqHisRead(xq, span, opts: null)

Read point history data - see XQuery.hisRead

---

meta

def	func:xqHisRead
is	func
lib	lib:xquery
name	xqHisRead

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqHisRollup

xqHisRollup(xq, fold, interval)

Rollup history data - see XQuery.hisRollup

---

meta

def	func:xqHisRollup
is	func
lib	lib:xquery
name	xqHisRollup

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqHisRollupAuto

xqHisRollupAuto(xq, interval: null)

Rollup history data - see XQuery.hisRollupAuto

---

meta

def	func:xqHisRollupAuto
is	func
lib	lib:xquery
name	xqHisRollupAuto

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqMap

xqMap(xq, expr)

Map the previous step using an Axon expr - see XQuery.map

---

meta

def	func:xqMap
is	func
lib	lib:xquery
name	xqMap

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqPivot

xqPivot(xq, shape)

Transform previous step into pivot table - see XQuery.pivot Note: column names and meta are subject to change.

---

meta

def	func:xqPivot
is	func
lib	lib:xquery
name	xqPivot

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqProjs

xqProjs(xq, names)

Restrict query to given project name(s) - see XQuery.projs. Also see navProjNames() to restrict a query to navigable projects.

---

meta

def	func:xqProjs
is	func
lib	lib:xquery
name	xqProjs

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqReadAll

xqReadAll(xq, filter, opts: null)

Read recs by filter - see XQuery.readAll

---

meta

def	func:xqReadAll
is	func
lib	lib:xquery
name	xqReadAll

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqReadAllList

xqReadAllList(xq, filter, opts: null)

Read recs by filter - see XQuery.readAllList

---

meta

def	func:xqReadAllList
is	func
lib	lib:xquery
name	xqReadAllList

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqReadByIds

xqReadByIds(xq, ids)

Read recs by ids - see XQuery.readByIds

---

meta

def	func:xqReadByIds
is	func
lib	lib:xquery
name	xqReadByIds

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqReadByIdsList

xqReadByIdsList(xq, ids)

Read recs by ids - see XQuery.readByIds

---

meta

def	func:xqReadByIdsList
is	func
lib	lib:xquery
name	xqReadByIdsList

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqTimeout

xqTimeout(xq, val)

Set timeout for network calls to remote nodes - see XQuery.timeout.

---

meta

def	func:xqTimeout
is	func
lib	lib:xquery
name	xqTimeout

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqTrace

xqTrace(xq)

Execute the XQuery and return debug tracing

---

meta

def	func:xqTrace
is	func
lib	lib:xquery
name	xqTrace

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

func:xqUseReplicas

xqUseReplicas(xq, val: true)

Route to replicas instead of master - see XQuery.useReplicas.

---

meta

def	func:xqUseReplicas
is	func
lib	lib:xquery
name	xqUseReplicas

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
func	Axon function

---

---

def

view:xquerySettings

Settings for the XQuery system module

---

meta

appName	settings
def	view:xquerySettings
disKey	ui::xquery
icon	view
is	view
lib	lib:xquery
su	✓

---

supertypes

feature	Feature namespace of definitions formatted as feature:name
view	Fresco UI view

---

src

view:   {inherit:"form"}
submit: {action:"hostCommit"}
data:   {expr:"hostSettings(\"xquery\")"}