<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.5">
  <compounddef id="group__client" kind="group">
    <compoundname>client</compoundname>
    <title>General client functions</title>
    <innerclass refid="structqdb__string__t" prot="public">qdb_string_t</innerclass>
    <innerclass refid="structqdb__timespec__t" prot="public">qdb_timespec_t</innerclass>
    <innerclass refid="structqdb__remote__node__t" prot="public">qdb_remote_node_t</innerclass>
    <innerclass refid="structqdb__id__t" prot="public">qdb_id_t</innerclass>
    <innerclass refid="structqdb__entry__metadata__t" prot="public">qdb_entry_metadata_t</innerclass>
      <sectiondef kind="enum">
      <memberdef kind="enum" id="group__client_1gab2ede040a754735a3f751a14acd8cf7f" prot="public" static="no">
        <name>qdb_limits_t</name>
        <enumvalue id="group__client_1ggab2ede040a754735a3f751a14acd8cf7fa5f7b5e1be562cf9e9bf141b7cba12fcf" prot="public">
          <name>qdb_l_max_alias_length</name>
          <initializer>= 1024</initializer>
          <briefdescription>
<para>The maximum allowed length for aliases. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="group__client_1ggab2ede040a754735a3f751a14acd8cf7fada77b67d62cfd28f8f9131dc039dbf64" prot="public">
          <name>qdb_l_alias_max_length</name>
          <initializer>= qdb_l_max_alias_length</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
<para><xrefsect id="deprecated_1_deprecated000001"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Please use <ref refid="group__client_1ggab2ede040a754735a3f751a14acd8cf7fa5f7b5e1be562cf9e9bf141b7cba12fcf" kindref="member">qdb_l_max_alias_length</ref>. </para></xrefdescription></xrefsect></para>          </detaileddescription>
        </enumvalue>
        <enumvalue id="group__client_1ggab2ede040a754735a3f751a14acd8cf7fab0110b72ff3e263a9de652302b75ef2d" prot="public">
          <name>qdb_l_max_user_name_length</name>
          <initializer>= 120</initializer>
          <briefdescription>
<para>The maximum allowed length of a user name. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="group__client_1ggab2ede040a754735a3f751a14acd8cf7fa65747a0c116aae149366cd8eb6ec05e7" prot="public">
          <name>qdb_max_user_name_length</name>
          <initializer>= qdb_l_max_user_name_length</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
<para><xrefsect id="deprecated_1_deprecated000002"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Please use <ref refid="group__client_1ggab2ede040a754735a3f751a14acd8cf7fab0110b72ff3e263a9de652302b75ef2d" kindref="member">qdb_l_max_user_name_length</ref>. </para></xrefdescription></xrefsect></para>          </detaileddescription>
        </enumvalue>
        <briefdescription>
<para>An enumeration of API limits. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="140" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="139" bodyend="149"/>
      </memberdef>
      <memberdef kind="enum" id="group__client_1gabbff9df8f8af25c6bdf97cabd157910b" prot="public" static="no">
        <name>qdb_protocol_t</name>
        <enumvalue id="client_8h_1gabbff9df8f8af25c6bdf97cabd157910ba2ce2bdabaf83de1269519c5ddec8d71b" prot="public">
          <name>qdb_p_tcp</name>
          <initializer>= 0</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
<para>Uses TCP/IP to communicate with the cluster. This is currently the only supported network protocol. </para>          </detaileddescription>
        </enumvalue>
        <briefdescription>
<para>An enumeration of allowed network protocols. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="see"><para><ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="156" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="155" bodyend="160"/>
      </memberdef>
      <memberdef kind="enum" id="group__client_1gaaa6272f78edda811822bfce05a07f944" prot="public" static="no">
        <name>qdb_entry_type_t</name>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a696fbb89655c7dd32c7a7e75b8681bcf" prot="public">
          <name>qdb_entry_uninitialized</name>
          <initializer>= -1</initializer>
          <briefdescription>
<para>Uninitialized value. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944ace9c26f51f6c16e8ddbc3f28186ab651" prot="public">
          <name>qdb_entry_blob</name>
          <initializer>= 0</initializer>
          <briefdescription>
<para>Binary large object (blob). </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a15e8fce791e52b1d141523cd57535f36" prot="public">
          <name>qdb_entry_integer</name>
          <initializer>= 1</initializer>
          <briefdescription>
<para>Signed 64-bit integer. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a0151c74b116bcf742d486f31e1875688" prot="public">
          <name>qdb_entry_hset</name>
          <initializer>= 2</initializer>
          <briefdescription>
<para>Distributed hash set. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a314adddcdc6c99386a4aaa52d2607a1a" prot="public">
          <name>qdb_entry_tag</name>
          <initializer>= 3</initializer>
          <briefdescription>
<para>Tag. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a9d5a0e0781bef6833f2520af9614aef3" prot="public">
          <name>qdb_entry_deque</name>
          <initializer>= 4</initializer>
          <briefdescription>
<para>Distributed double-entry queue (deque). </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944ae5094abbbeb67d245fb26cd935e3eb4a" prot="public">
          <name>qdb_entry_stream</name>
          <initializer>= 5</initializer>
          <briefdescription>
<para>Distributed binary stream. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a7f19bbb0e69b4eb2e263ef47a30e7869" prot="public">
          <name>qdb_entry_ts</name>
          <initializer>= 6</initializer>
          <briefdescription>
<para>Distributed time series. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a9a28bbefabc20fd2fc53f4de20fcd49d" prot="public">
          <name>qdb_entry_internal_ts_double_bucket</name>
          <initializer>= 20</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a8e5dc9111474ec727be3a4e2064aa888" prot="public">
          <name>qdb_entry_internal_ts_blob_bucket</name>
          <initializer>= 21</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944ad25820e990b1eaee486f12c30f8a9111" prot="public">
          <name>qdb_entry_internal_ts_int64_bucket</name>
          <initializer>= 22</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a86969898a15965813df29f1c14dda0cc" prot="public">
          <name>qdb_entry_internal_ts_timestamp_bucket</name>
          <initializer>= 23</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a1e70c9d9468405adc700e2fa3f894039" prot="public">
          <name>qdb_entry_internal_ts_string_bucket</name>
          <initializer>= 24</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a0083ed797568c6f3b23800fd749a4102" prot="public">
          <name>qdb_entry_internal_ts_double_bucket_index</name>
          <initializer>= 30</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944aeb15136358f09bc028a613554d0eea81" prot="public">
          <name>qdb_entry_internal_ts_blob_bucket_index</name>
          <initializer>= 31</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a987f37cb8b184f67f1653f9b971378a5" prot="public">
          <name>qdb_entry_internal_ts_int64_bucket_index</name>
          <initializer>= 32</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a027e999e3d063d1a9b12459fe4939a68" prot="public">
          <name>qdb_entry_internal_ts_timestamp_bucket_index</name>
          <initializer>= 33</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944ad9a99e10dd67d3156bfa6ac4ce6ca488" prot="public">
          <name>qdb_entry_internal_ts_string_bucket_index</name>
          <initializer>= 34</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1gaaa6272f78edda811822bfce05a07f944a070574b99037a796ce67dd240b70cdee" prot="public">
          <name>qdb_entry_internal_directory</name>
          <initializer>= 50</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
<para>A enumeration representing possible entries type. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="220" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="219" bodyend="249"/>
      </memberdef>
      <memberdef kind="enum" id="group__client_1ga51870cfb3be20f3206fec2d39412c50f" prot="public" static="no">
        <name>qdb_compact_options_t</name>
        <enumvalue id="client_8h_1ga51870cfb3be20f3206fec2d39412c50fa2b58f4eb7f57ab01ed3faf046f51aa0b" prot="public">
          <name>qdb_compact_full</name>
          <initializer>= 0</initializer>
          <briefdescription>
<para>Compact the entire database in a single operation. </para>          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="client_8h_1ga51870cfb3be20f3206fec2d39412c50faa5efed317e1d388196d8e4638aa0f9c2" prot="public">
          <name>qdb_compact_piecewise</name>
          <initializer>= 1</initializer>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
<para>Compact the database one slice at a time (reduces peak disk usage during compaction) </para>          </detaileddescription>
        </enumvalue>
        <briefdescription>
<para>An enumeration of compact options. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="see"><para><ref refid="group__client_1ga5b9b7d475116b6bcb88103c753701702" kindref="member">qdb_cluster_compact</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="727" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="726" bodyend="733"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="typedef">
      <memberdef kind="typedef" id="group__client_1ga7f34d299f1e797c385ef604ffd283e48" prot="public" static="no">
        <type>enum <ref refid="group__client_1gab2ede040a754735a3f751a14acd8cf7f" kindref="member">qdb_limits_t</ref></type>
        <definition>typedef enum qdb_limits_t  qdb_limits_t</definition>
        <argsstring></argsstring>
        <name>qdb_limits_t</name>
        <briefdescription>
<para>An enumeration of API limits. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="149" column="1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__client_1ga4745ed10b405291a321ec7150368a4b1" prot="public" static="no">
        <type>long long</type>
        <definition>qdb_time_t</definition>
        <argsstring></argsstring>
        <name>qdb_time_t</name>
        <briefdescription>
<para>A cross-platform type that represents a time value. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="see"><para><ref refid="group__client_1gad9d32d4869c9950803f7cde8893de1fa" kindref="member">qdb_expires_at</ref> </para></simplesect>
<simplesect kind="remark"><para><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref> MUST be 64-bit large. The API will probably not link otherwise. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="93" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="93" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__client_1ga2b6f368592c49501d41ec2330b964147" prot="public" static="no">
        <type>size_t</type>
        <definition>qdb_size_t</definition>
        <argsstring></argsstring>
        <name>qdb_size_t</name>
        <briefdescription>
<para>An alias for size_t. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="104" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="104" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__client_1ga17492cb84da5466d0c742f0561df6597" prot="public" static="no">
        <type>int64_t</type>
        <definition>qdb_int_t</definition>
        <argsstring></argsstring>
        <name>qdb_int_t</name>
        <briefdescription>
<para>A cross-platform type that represents a signed 64-bit integer. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="118" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="118" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__client_1ga720fb72da4197685cc354214e96796c1" prot="public" static="no">
        <type>struct qdb_handle_internal *</type>
        <definition>qdb_handle_t</definition>
        <argsstring></argsstring>
        <name>qdb_handle_t</name>
        <briefdescription>
<para>An opaque handle to internal API-allocated structures needed for maintaining connection to a cluster. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="167" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="167" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__client_1ga7f8cd1ef34cbbcc7aa63ae0bdcd6c3a0" prot="public" static="no">
        <type>struct qdb_direct_handle_internal *</type>
        <definition>qdb_direct_handle_t</definition>
        <argsstring></argsstring>
        <name>qdb_direct_handle_t</name>
        <briefdescription>
<para>An opaque handle to internal API-allocated structures needed for maintaining a direct connection to a cluster. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/direct.h" line="48" column="1" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/direct.h" bodystart="48" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="group__client_1gab0ffd6b2788132113bf3152d2d8bb329" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> const char *</type>
        <definition>QDB_API_LINKAGE const char* qdb_version</definition>
        <argsstring>(void)</argsstring>
        <name>qdb_version</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Returns a null-terminated string describing the API version. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>A static, null-terminated string describing the API version. The buffer is API managed and should not be freed or written to by the caller. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="320" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga9be759a55d51e1d1407150985ff1397e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> const char *</type>
        <definition>QDB_API_LINKAGE const char* qdb_build</definition>
        <argsstring>(void)</argsstring>
        <name>qdb_build</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Returns a null-terminated string describing the exact API build. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>A static, null-terminated string describing the exact API build. The buffer is API managed and should not be freed or written to by the caller. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="328" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_open</definition>
        <argsstring>(qdb_handle_t *handle, qdb_protocol_t proto)</argsstring>
        <name>qdb_open</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref> *</type>
          <declname>handle</declname>
        </param>
        <param>
          <type><ref refid="group__client_1gabbff9df8f8af25c6bdf97cabd157910b" kindref="member">qdb_protocol_t</ref></type>
          <declname>proto</declname>
        </param>
        <briefdescription>
<para>Creates a <ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref>. No connection will be established. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="out">handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a <ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref> that will be ready to connect to a cluster.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>proto</parametername>
</parameternamelist>
<parameterdescription>
<para>The protocol to use.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gab10eb8485f7e3088c91800b0dd254b71" kindref="member">qdb_connect</ref>, <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>, <ref refid="group__client_1gabbff9df8f8af25c6bdf97cabd157910b" kindref="member">qdb_protocol_t</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="341" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_handle_t qdb_open_tcp</definition>
        <argsstring>(void)</argsstring>
        <name>qdb_open_tcp</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Creates a TCP/IP qdb_handle_t. No connection will be established. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>An initialized qdb_handle_t, ready to connect, in case of success, NULL in case of failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gab10eb8485f7e3088c91800b0dd254b71" kindref="member">qdb_connect</ref>, <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="351" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga3101ada974be84531c52a9347b456b24" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_get_last_error</definition>
        <argsstring>(qdb_handle_t handle, qdb_error_t *error, qdb_string_t *message)</argsstring>
        <name>qdb_get_last_error</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type><ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref> *</type>
          <declname>error</declname>
        </param>
        <param>
          <type><ref refid="structqdb__string__t" kindref="compound">qdb_string_t</ref> *</type>
          <declname>message</declname>
        </param>
        <briefdescription>
<para>Describes the last error code returned from the given handle. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">error</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional pointer to a <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> that will be set to the error code of the last API call with the given handle.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">message</parametername>
</parameternamelist>
<parameterdescription>
<para>An optional pointer to a <ref refid="structqdb__string__t" kindref="compound">qdb_string_t</ref> that will store a message describing the last API call with the given handle. The buffer is API managed and should not be freed or written to by the caller. It&apos;s invalidated by subsequent API calls.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="369" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gab10eb8485f7e3088c91800b0dd254b71" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_connect</definition>
        <argsstring>(qdb_handle_t handle, const char *uri)</argsstring>
        <name>qdb_connect</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>uri</declname>
        </param>
        <briefdescription>
<para>Binds the client instance to a quasardb cluster and connect to at least one node within. </para>        </briefdescription>
        <detaileddescription>
<para>Quasardb URI are in the form <computeroutput>qdb://&lt;address&gt;:&lt;port&gt;</computeroutput> where <computeroutput>&lt;address&gt;</computeroutput> is either an IPv4 or IPv6 (surrounded with square brackets), or a domain name. It is recommended to specify multiple addresses should the designated node be unavailable.</para><para>URI examples:<itemizedlist>
<listitem><para><computeroutput>qdb://myserver.org:2836</computeroutput> - Connects to myserver.org on the port 2836</para></listitem><listitem><para><computeroutput>qdb://127.0.0.1:2836</computeroutput> - Connects to the local IPv4 loopback on the port 2836</para></listitem><listitem><para><computeroutput>qdb://myserver1.org:2836,myserver2.org:2836</computeroutput> - Connects to myserver1.org or myserver2.org on the port 2836</para></listitem><listitem><para><computeroutput>qdb://[::1]:2836</computeroutput> - Connects to the local IPv6 loopback on the port 2836</para></listitem></itemizedlist>
</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>uri</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the URI of the quasardb cluster to connect to.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref>, <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref> </para></simplesect>
<simplesect kind="attention"><para>Make sure all the addresses in the URI belong to the same cluster </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="404" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gadbacfb13356c82e1cf54896ed4d8fb58" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_close</definition>
        <argsstring>(qdb_handle_t handle)</argsstring>
        <name>qdb_close</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <briefdescription>
<para>Closes the handle previously opened with <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>. </para>        </briefdescription>
        <detaileddescription>
<para>This results in terminating all connections and releasing all internal buffers, including buffers which may have been allocated as or a result of batch operations or get operations.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="attention"><para>API-allocated buffers may be released by this call. For example, the buffer allocated by <ref refid="group__blob_1ga79619e400997cf67c7f213fbcccd88c4" kindref="member">qdb_blob_get</ref> may be released by this call. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="424" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gac730e57a2af51766f07acf092bdd6e22" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_copy_alloc_buffer</definition>
        <argsstring>(qdb_handle_t handle, const void *source_buffer, qdb_size_t source_buffer_size, const void **dest_buffer)</argsstring>
        <name>qdb_copy_alloc_buffer</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const void *</type>
          <declname>source_buffer</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga2b6f368592c49501d41ec2330b964147" kindref="member">qdb_size_t</ref></type>
          <declname>source_buffer_size</declname>
        </param>
        <param>
          <type>const void **</type>
          <declname>dest_buffer</declname>
        </param>
        <briefdescription>
<para>Creates a clone of a buffer using API&apos;s high-performance memory allocator. </para>        </briefdescription>
        <detaileddescription>
<para>The allocated buffer has to be released later with <ref refid="group__client_1ga31b15fb83e60b9cb16504618616f29f3" kindref="member">qdb_release</ref>.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>source_buffer</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a buffer to clone</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>source_buffer_size</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the buffer to clone</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dest_buffer</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a a pointer of an API-allocated buffer whose content will be a copy of the source buffer</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1ga31b15fb83e60b9cb16504618616f29f3" kindref="member">qdb_release</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="446" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga31b15fb83e60b9cb16504618616f29f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> void</type>
        <definition>QDB_API_LINKAGE void qdb_release</definition>
        <argsstring>(qdb_handle_t handle, const void *buffer)</argsstring>
        <name>qdb_release</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const void *</type>
          <declname>buffer</declname>
        </param>
        <briefdescription>
<para>Releases an API-allocated buffer. </para>        </briefdescription>
        <detaileddescription>
<para>Failure to properly call this function may result in excessive memory usage. Most operations that return a content (e.g. batch operations, <ref refid="group__blob_1ga79619e400997cf67c7f213fbcccd88c4" kindref="member">qdb_blob_get</ref>, <ref refid="group__blob_1gad2ac5b09a51722c08bda77eaff228e9d" kindref="member">qdb_blob_get_and_update</ref>, <ref refid="group__blob_1gac15e696f07b3099e8390fdf7acb3352f" kindref="member">qdb_blob_compare_and_swap</ref>...) will allocate a buffer for the content and will not release the allocated buffer until you either call this function or close the handle.</para><para>The function will be able to release any kind of buffer allocated by a quasardb API call, whether it&apos;s a single buffer, an array or an array of buffers.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>buffer</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an API-allocated buffer to release. The behavior for non API buffers is undefined. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="470" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gae2e11082ceb8cb647680482b9056a2a2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_remove</definition>
        <argsstring>(qdb_handle_t handle, const char *alias)</argsstring>
        <name>qdb_remove</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <briefdescription>
<para>Removes an entry from the cluster, regardless of its type. </para>        </briefdescription>
        <detaileddescription>
<para>This call will remove the entry, whether it is a blob, integer, deque, or hset. It will properly untag the entry. If the entry spawns on multiple entries or nodes (deques and hsets), all blocks will be properly removed.</para><para>The call is ACID, regardless of the type of the entry and a transaction will be created if need be.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="490" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gad9d32d4869c9950803f7cde8893de1fa" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_expires_at</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_time_t expiry_time)</argsstring>
        <name>qdb_expires_at</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref></type>
          <declname>expiry_time</declname>
        </param>
        <briefdescription>
<para>Sets the absolute expiration time of an entry, if the type supports expiration. </para>        </briefdescription>
        <detaileddescription>
<para>Blobs and integers can have an expiration time and will be automatically removed by the cluster when they expire.</para><para>The absolute expiration time is the Unix epoch, that is, the number of milliseconds since 1 January 1970, 00:00:00 UTC. To use a relative expiration time (that is expiration relative to the time of the call), use <ref refid="group__client_1gae3cd85f8720077bf2345e8c294f8b4b2" kindref="member">qdb_expires_from_now</ref>.</para><para>To remove the expiration time of an entry, specify the value <ref refid="group__client_1gad64f32e3ffa0f7c4ebe486c178dd297d" kindref="member">qdb_never_expires</ref> as <computeroutput>expiry_time</computeroutput> parameter.</para><para>Values in the past are refused, but the cluster will have a certain tolerance to account for clock skews.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>expiry_time</parametername>
</parameternamelist>
<parameterdescription>
<para>The new, absolute UTC expiration time.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="attention"><para>It is an error to specify an expiration in the past, although the cluster has a certain tolerance to account for clock synchronization </para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gae3cd85f8720077bf2345e8c294f8b4b2" kindref="member">qdb_expires_from_now</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="524" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gae3cd85f8720077bf2345e8c294f8b4b2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_expires_from_now</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_time_t expiry_delta)</argsstring>
        <name>qdb_expires_from_now</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref></type>
          <declname>expiry_delta</declname>
        </param>
        <briefdescription>
<para>Sets the expiration time of an entry, relative to the current time of the client, if the type supports expiration. </para>        </briefdescription>
        <detaileddescription>
<para>Blobs and integers can have an expiration time and will automatically be removed by the cluster when they expire.</para><para>The expiration is relative to the current time of the machine.</para><para>To remove the expiration time of an entry or to use an absolute expiration time use <ref refid="group__client_1gad9d32d4869c9950803f7cde8893de1fa" kindref="member">qdb_expires_at</ref>.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>expiry_delta</parametername>
</parameternamelist>
<parameterdescription>
<para>The number of milliseconds, relative to the current time, after which the entry should expire.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gad9d32d4869c9950803f7cde8893de1fa" kindref="member">qdb_expires_at</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="552" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga596f19e470bf460cd552db37530961e6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_get_expiry_time</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_time_t *expiry_time)</argsstring>
        <name>qdb_get_expiry_time</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref> *</type>
          <declname>expiry_time</declname>
        </param>
        <briefdescription>
<para>Retrieves the absolute expiration time of the given entry. </para>        </briefdescription>
        <detaileddescription>
<para>The returned expiration time is the Unix epoch, UTC.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">expiry_time</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to an expiry time which will be set to the expiration of the entry if the call is successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gae3cd85f8720077bf2345e8c294f8b4b2" kindref="member">qdb_expires_from_now</ref> </para><simplesectsep/><para><ref refid="group__client_1gad9d32d4869c9950803f7cde8893de1fa" kindref="member">qdb_expires_at</ref> </para><simplesectsep/><para><ref refid="group__client_1gae2647bb54f4ba01dbad2fd09255d875d" kindref="member">qdb_get_metadata</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="576" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga00e927042f6f031e2b07bc8b2ea579f9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_get_location</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_remote_node_t *location)</argsstring>
        <name>qdb_get_location</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="structqdb__remote__node__t" kindref="compound">qdb_remote_node_t</ref> *</type>
          <declname>location</declname>
        </param>
        <briefdescription>
<para>Returns the primary node of an entry. </para>        </briefdescription>
        <detaileddescription>
<para>The exact location of an entry should be assumed random and users should not bother about its location as the API will transparently locate the best node for the requested operation.</para><para>This function is intended for higher level APIs that need to optimize transfers and potentially push computation close to the data.</para><para>This function allocates memory for the null terminated address string call qdb_release on the location structure to release memory.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">location</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a <ref refid="structqdb__remote__node__t" kindref="compound">qdb_remote_node_t</ref> structure that will receive the address of the primary node of the entry if successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1ga31b15fb83e60b9cb16504618616f29f3" kindref="member">qdb_release</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="606" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga6446b0628a8ee9639e1fa0da3c6c8527" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_get_type</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_entry_type_t *entry_type)</argsstring>
        <name>qdb_get_type</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="group__client_1gaaa6272f78edda811822bfce05a07f944" kindref="member">qdb_entry_type_t</ref> *</type>
          <declname>entry_type</declname>
        </param>
        <briefdescription>
<para>Gets the type of an entry, if it exists. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">entry_type</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a <ref refid="group__client_1gaaa6272f78edda811822bfce05a07f944" kindref="member">qdb_entry_type_t</ref> that will receive the type of the entry if successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1gae2647bb54f4ba01dbad2fd09255d875d" kindref="member">qdb_get_metadata</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="626" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gae2647bb54f4ba01dbad2fd09255d875d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_get_metadata</definition>
        <argsstring>(qdb_handle_t handle, const char *alias, qdb_entry_metadata_t *entry_metadata)</argsstring>
        <name>qdb_get_metadata</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>alias</declname>
        </param>
        <param>
          <type><ref refid="structqdb__entry__metadata__t" kindref="compound">qdb_entry_metadata_t</ref> *</type>
          <declname>entry_metadata</declname>
        </param>
        <briefdescription>
<para>Gets the meta-information about an entry, if it exists. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>alias</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a null-terminated UTF-8 string representing the alias of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">entry_metadata</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a <ref refid="structqdb__entry__metadata__t" kindref="compound">qdb_entry_metadata_t</ref> that will receive the metadata of the entry if successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="644" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga4a605b01e3ae5a0d4b45623913fac8ca" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_get_metadata_by_id</definition>
        <argsstring>(qdb_handle_t handle, const qdb_id_t *reference, qdb_entry_metadata_t *entry_metadata)</argsstring>
        <name>qdb_get_metadata_by_id</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const <ref refid="structqdb__id__t" kindref="compound">qdb_id_t</ref> *</type>
          <declname>reference</declname>
        </param>
        <param>
          <type><ref refid="structqdb__entry__metadata__t" kindref="compound">qdb_entry_metadata_t</ref> *</type>
          <declname>entry_metadata</declname>
        </param>
        <briefdescription>
<para>Gets the meta-information about an entry, if it exists. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>reference</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a structure representing the internal reference of the entry.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">entry_metadata</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a <ref refid="structqdb__entry__metadata__t" kindref="compound">qdb_entry_metadata_t</ref> that will receive the metadata of the entry if successful.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="662" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga13f319e5668ebfe2e915a41a1a860013" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_purge_all</definition>
        <argsstring>(qdb_handle_t handle, int timeout_ms)</argsstring>
        <name>qdb_purge_all</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>int</type>
          <declname>timeout_ms</declname>
        </param>
        <briefdescription>
<para>Removes irremediably all data from all the nodes of the cluster. </para>        </briefdescription>
        <detaileddescription>
<para>This function is useful when quasardb is used as a cache and is not the golden source.</para><para>This call is not atomic: if the command cannot be dispatched on the whole cluster, it will be dispatched on as many nodes as possible and the function will return with a <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443aad6d0d2fb89cdc604785b0d0b422b082" kindref="member">qdb_e_ok</ref> code.</para><para>By default cluster does not allow this operation and the function returns a <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443a5e3f7ff277511984a70139328714d839" kindref="member">qdb_e_operation_disabled</ref> error.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>timeout_ms</parametername>
</parameternamelist>
<parameterdescription>
<para>A timeout value, in milliseconds.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="attention"><para>Use this function at your own risk. This function causes irremediable data loss. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="688" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga731f547a21f4578d65e4b64515f6b264" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_trim_all</definition>
        <argsstring>(qdb_handle_t handle, int timeout_ms)</argsstring>
        <name>qdb_trim_all</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>int</type>
          <declname>timeout_ms</declname>
        </param>
        <briefdescription>
<para>Trims all data on all the nodes of the cluster. </para>        </briefdescription>
        <detaileddescription>
<para>quasardb uses Multi-Version Concurrency Control (MVCC) as a foundation of its transaction engine. It will automatically clean up old versions as entries are accessed.</para><para>This call is not atomic: if the command cannot be dispatched on the whole cluster, it will be dispatched on as many nodes as possible and the function will return with a <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443aad6d0d2fb89cdc604785b0d0b422b082" kindref="member">qdb_e_ok</ref> code.</para><para>Entries that are not accessed may not be cleaned up, resulting in increasing disk usage.</para><para>This function will request each node to trim all entries and release unused memory. Because this operation is I/O and CPU intensive, it is not recommended to run it when the cluster is heavily used.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>timeout_ms</parametername>
</parameternamelist>
<parameterdescription>
<para>A timeout value, in milliseconds.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="attention"><para>This function impacts the performance of the cluster.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1ga5b9b7d475116b6bcb88103c753701702" kindref="member">qdb_cluster_compact</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="719" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga5b9b7d475116b6bcb88103c753701702" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_cluster_compact</definition>
        <argsstring>(qdb_handle_t handle, qdb_compact_options_t options, int timeout_ms)</argsstring>
        <name>qdb_cluster_compact</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga51870cfb3be20f3206fec2d39412c50f" kindref="member">qdb_compact_options_t</ref></type>
          <declname>options</declname>
        </param>
        <param>
          <type>int</type>
          <declname>timeout_ms</declname>
        </param>
        <briefdescription>
<para>Compacts all data in the persistence layer on all the nodes of the cluster. </para>        </briefdescription>
        <detaileddescription>
<para>This function will request each nodes to compact files on disk. Because this operation is I/O and CPU intensive, it is not recommended to run it when the cluster is heavily used.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>options</parametername>
</parameternamelist>
<parameterdescription>
<para>Options for the compaction operation.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>timeout_ms</parametername>
</parameternamelist>
<parameterdescription>
<para>A timeout value, in milliseconds.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="attention"><para>This function impacts the performance of the cluster.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1ga731f547a21f4578d65e4b64515f6b264" kindref="member">qdb_trim_all</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="756" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gae171ad6b88f7108682caefc280fe9e6d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_purge_cache</definition>
        <argsstring>(qdb_handle_t handle, int timeout_ms)</argsstring>
        <name>qdb_purge_cache</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>int</type>
          <declname>timeout_ms</declname>
        </param>
        <briefdescription>
<para>Removes all cached data from all the nodes of the cluster. </para>        </briefdescription>
        <detaileddescription>
<para>This function is disabled on a transient cluster. Prefer purge_all in this case.</para><para>This call is not atomic: if the command cannot be dispatched on the whole cluster, it will be dispatched on as many nodes as possible and the function will return with a <ref refid="group__error_1gga365e768c3ca0f6387d8798eb98c40443aad6d0d2fb89cdc604785b0d0b422b082" kindref="member">qdb_e_ok</ref> code.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>timeout_ms</parametername>
</parameternamelist>
<parameterdescription>
<para>A timeout value, in milliseconds.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="776" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga2cb8462f6902667420894701d588dea2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_wait_for_stabilization</definition>
        <argsstring>(qdb_handle_t handle, int timeout_ms)</argsstring>
        <name>qdb_wait_for_stabilization</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>int</type>
          <declname>timeout_ms</declname>
        </param>
        <briefdescription>
<para>Wait for all nodes of the cluster to be stabilized. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>timeout_ms</parametername>
</parameternamelist>
<parameterdescription>
<para>A timeout value, in milliseconds.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="788" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga28fcc096a0543a8e54056ececd6e1c75" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_cluster_endpoints</definition>
        <argsstring>(qdb_handle_t handle, qdb_remote_node_t **endpoints, qdb_size_t *endpoints_count)</argsstring>
        <name>qdb_cluster_endpoints</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type><ref refid="structqdb__remote__node__t" kindref="compound">qdb_remote_node_t</ref> **</type>
          <declname>endpoints</declname>
        </param>
        <param>
          <type><ref refid="group__client_1ga2b6f368592c49501d41ec2330b964147" kindref="member">qdb_size_t</ref> *</type>
          <declname>endpoints_count</declname>
        </param>
        <briefdescription>
<para>Retrieve a sorted array of endpoints. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">endpoints</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a <ref refid="structqdb__remote__node__t" kindref="compound">qdb_remote_node_t</ref> array that will receive the addresses of the nodes of the cluster</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">endpoints_count</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer that will be filled with number of nodes in the array</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="805" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga7e740cab0f93bf0449026aac72f0a7b8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_cluster_reload_user_config</definition>
        <argsstring>(qdb_handle_t handle)</argsstring>
        <name>qdb_cluster_reload_user_config</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <briefdescription>
<para>Reload user configuration from file. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="817" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga8aaf6c6f60163c385d79a2043a9ed199" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> const char *</type>
        <definition>QDB_API_LINKAGE const char* qdb_error</definition>
        <argsstring>(qdb_error_t error)</argsstring>
        <name>qdb_error</name>
        <param>
          <type><ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
          <declname>error</declname>
        </param>
        <briefdescription>
<para>Translates an error code into an English error message. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>error</parametername>
</parameternamelist>
<parameterdescription>
<para>The <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code outputted by another function</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A static, null-terminated string describing the error. The buffer is API managed and should not be freed or written to by the caller. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/error.h" line="270" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1gafbb7ef08e73f0353388ca2dc9900e0f7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_query_copy_results</definition>
        <argsstring>(qdb_handle_t handle, const qdb_query_result_t *result, qdb_query_result_t **result_copy)</argsstring>
        <name>qdb_query_copy_results</name>
        <param>
          <type><ref refid="group__client_1ga720fb72da4197685cc354214e96796c1" kindref="member">qdb_handle_t</ref></type>
          <declname>handle</declname>
        </param>
        <param>
          <type>const <ref refid="structqdb__query__result__t" kindref="compound">qdb_query_result_t</ref> *</type>
          <declname>result</declname>
        </param>
        <param>
          <type><ref refid="structqdb__query__result__t" kindref="compound">qdb_query_result_t</ref> **</type>
          <declname>result_copy</declname>
        </param>
        <briefdescription>
<para>Creates a clone of a query result. </para>        </briefdescription>
        <detaileddescription>
<para>The allocated results have to be released later with <ref refid="group__client_1ga31b15fb83e60b9cb16504618616f29f3" kindref="member">qdb_release</ref>.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>A valid handle previously initialized by <ref refid="group__client_1gaa86900c81459a8d60b9b7b042371fa1e" kindref="member">qdb_open</ref> or <ref refid="group__client_1gab7a783a4a0cc73211ad96b9685f2c67e" kindref="member">qdb_open_tcp</ref>.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>result</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a buffer to clone</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">result_copy</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to a a pointer that will receive API-allocated results whose content will be a copy of the source results</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__client_1ga31b15fb83e60b9cb16504618616f29f3" kindref="member">qdb_release</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/query.h" line="241" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__client_1ga5381c438bbdf8f637e9257793679344a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="group__attr_1ga008cbf050a89152ec67d33e534cd3012" kindref="member">QDB_API_LINKAGE</ref> <ref refid="group__error_1ga365e768c3ca0f6387d8798eb98c40443" kindref="member">qdb_error_t</ref></type>
        <definition>QDB_API_LINKAGE qdb_error_t qdb_tag_iterator_copy</definition>
        <argsstring>(const qdb_const_tag_iterator_t *original, qdb_const_tag_iterator_t *copy)</argsstring>
        <name>qdb_tag_iterator_copy</name>
        <param>
          <type>const <ref refid="structqdb__const__tag__iterator__t" kindref="compound">qdb_const_tag_iterator_t</ref> *</type>
          <declname>original</declname>
        </param>
        <param>
          <type><ref refid="structqdb__const__tag__iterator__t" kindref="compound">qdb_const_tag_iterator_t</ref> *</type>
          <declname>copy</declname>
        </param>
        <briefdescription>
<para>Clones a previously initialized tag iterator. </para>        </briefdescription>
        <detaileddescription>
<para>Copies the state of the original iterator to a new iterator. Both iterators can be independently operated afterwards. The cloned iterator will have to be closed with <ref refid="group__tag_1ga984b421bc7c89bfbd62a1ceeb8fa61e1" kindref="member">qdb_tag_iterator_close</ref>.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>original</parametername>
</parameternamelist>
<parameterdescription>
<para>The original iterator to copy, source.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">copy</parametername>
</parameternamelist>
<parameterdescription>
<para>An uninitialized iterator to be set, destination.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A <ref refid="group__error_1gab1b09622035af18ab20ed4fd3b61dd46" kindref="member">qdb_error_t</ref> code indicating success or failure.</para></simplesect>
<simplesect kind="see"><para><ref refid="group__tag_1ga0f668af01c9168d82226f5e22c9c64f1" kindref="member">qdb_tag_iterator_begin</ref>, <ref refid="group__tag_1ga984b421bc7c89bfbd62a1ceeb8fa61e1" kindref="member">qdb_tag_iterator_close</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/tag.h" line="411" column="1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__client_1gad64f32e3ffa0f7c4ebe486c178dd297d" prot="public" static="no">
        <name>qdb_never_expires</name>
        <initializer>((<ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref>)0u)</initializer>
        <briefdescription>
<para>An arbitrary time value representing the &quot;no expiration&quot; time value. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="see"><para><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="126" column="9" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="126" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__client_1gacec73da0a3d7364196f4e6682f5fd522" prot="public" static="no">
        <name>qdb_preserve_expiration</name>
        <initializer>((<ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref>)0xFFFFFFFFFFFFFFFFULL)</initializer>
        <briefdescription>
<para>An arbitrary time value representing the &quot;preserve existing
expiration&quot; time value. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="see"><para><ref refid="group__client_1ga4745ed10b405291a321ec7150368a4b1" kindref="member">qdb_time_t</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" line="132" column="9" bodyfile="/mnt/resource/TeamCity/work/3d07d6036e644765/api/include/qdb/client.h" bodystart="132" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>
