module tailf-common-query {

    yang-version 1;

    namespace
      "http://tail-f.com/ns/common/query";

    prefix tfcq;

    import ietf-yang-types {
      prefix yang;
    }
    import tailf-common {
      prefix tailf;
    }

    organization "Tail-f Systems";

    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.";

    revision "2017-12-15" {
      description
        "Released as part of ConfD-6.5.2.1 / NCS-4.5.3.

Added 'immediate-query' function.";
    }

    revision "2017-04-27" {
      description
        "Released as part of ConfD-6.4.1 / NCS-4.4.1.

Added 'timeout' as parameter for start-query and reset-query.";
    }

    revision "2015-03-19" {
      description
        "Released as part of ConfD-5.4 / NCS-3.4.

Added 'inline' as a type for query results.";
    }

    revision "2014-11-13" {
      description "Initial revision.";
    }

  }  // module tailf-common-query