tailf-common-query

Organization:

Tail-f Systems

Module:

tailf-common-query

Version:

2017-12-15

File:

tailf-common-query.yang

Abstract:

Common groupings for the Query API. These groupings are used by protocol-specific modules; currently one for NETCONF (tailf-net...

Contact:

Check for an additional details:

YANG Catalog

Description:

Common groupings for the Query API. These groupings
are used by protocol-specific modules; currently one for
NETCONF (tailf-netconf-query) and one for REST
(tailf-rest-query).

The Query API has five functions: 'start-query',
'fetch-query-result', 'immediate-query', 'reset-query', and
'stop-query'.

'start-query' is used to start a new query. It returns
a query handle, before the system has started to evaluate
the query. The query-handle is used in the other
functions.

'fetch-query-result' is repeatedly used to get chunks of the
result of the query.

'immediate-query' is used to start a new query, and return
the entire result.

'reset-query' is optionally used to restart the query, possibly
from a new offset in the result.

'stop-query' cleans up the resources associated with the query.

This module defines the input and output parameters to these
functions as groupings. The protocol-specific modules that use
these groupings encapsulate them in protocol-specifc operations.

Copyright 2019 Cisco Systems, Inc.
All rights reserved.
Permission is hereby granted to redistribute this file without
modification.