blob: 6c0f3f52bb015a1ef7b642ed4af6d92b8df1cbee [file]
<?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.9.8" xml:lang="en-US">
<compounddef id="classpaimon_1_1_predicate_builder" kind="class" language="C++" prot="public">
<compoundname>paimon::PredicateBuilder</compoundname>
<includes refid="predicate__builder_8h" local="no">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a25a7430e29c0b20d3e8f71cbfcb17592" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>paimon::PredicateBuilder::PredicateBuilder</definition>
<argsstring>()=delete</argsstring>
<name>PredicateBuilder</name>
<qualifiedname>paimon::PredicateBuilder::PredicateBuilder</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="39" column="5"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1abe75fa206dea6ccc1fbe472a164c5349" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>paimon::PredicateBuilder::~PredicateBuilder</definition>
<argsstring>()=delete</argsstring>
<name>~PredicateBuilder</name>
<qualifiedname>paimon::PredicateBuilder::~PredicateBuilder</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="40" column="5"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-static-func">
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1af7c0b087116a2be113c7c2f1f87f9ce6" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::Equal</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>Equal</name>
<qualifiedname>paimon::PredicateBuilder::Equal</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create an equality predicate (field == literal). </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>field_index</parametername>
</parameternamelist>
<parameterdescription>
<para>The index of the field in read schema (0-based). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>field_name</parametername>
</parameternamelist>
<parameterdescription>
<para>The name of the field. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>field_type</parametername>
</parameternamelist>
<parameterdescription>
<para>The data type of the field. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>literal</parametername>
</parameternamelist>
<parameterdescription>
<para>The literal value to compare against. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>A shared pointer to the created <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> object. </para>
</simplesect>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="49" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1aa11272547168a86576a88c948a16b64f" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::NotEqual</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>NotEqual</name>
<qualifiedname>paimon::PredicateBuilder::NotEqual</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a not-equal predicate (field != literal). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="53" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a14bb8fb3e5852ec0a45619e69dd510c9" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::LessThan</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>LessThan</name>
<qualifiedname>paimon::PredicateBuilder::LessThan</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a less-than predicate (field &lt; literal). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="57" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1aa78d85ca6da23d9ac47aaa4bd2aa20a7" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::LessOrEqual</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>LessOrEqual</name>
<qualifiedname>paimon::PredicateBuilder::LessOrEqual</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a less-than-or-equal predicate (field &lt;= literal). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="61" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a6e38bfeaa61e4e22dad2986d0cc03c40" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::GreaterThan</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>GreaterThan</name>
<qualifiedname>paimon::PredicateBuilder::GreaterThan</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a greater-than predicate (field &gt; literal). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="67" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a69db050634bfe031d9ea47d067894600" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::GreaterOrEqual</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>GreaterOrEqual</name>
<qualifiedname>paimon::PredicateBuilder::GreaterOrEqual</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a greater-than-or-equal predicate (field &gt;= literal). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="73" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a7a2e26287726a9afa045c42ca55b53c1" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::IsNull</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type)</argsstring>
<name>IsNull</name>
<qualifiedname>paimon::PredicateBuilder::IsNull</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<briefdescription>
<para>Create an IS NULL predicate (field IS NULL). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="79" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a94b46109726bd4cb8ad191238db9ac9e" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::IsNotNull</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type)</argsstring>
<name>IsNotNull</name>
<qualifiedname>paimon::PredicateBuilder::IsNotNull</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<briefdescription>
<para>Create an IS NOT NULL predicate (field IS NOT NULL). </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="83" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1ab77c27dba229ac890edc7b15124442dc" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::In</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const std::vector&lt; Literal &gt; &amp;literals)</argsstring>
<name>In</name>
<qualifiedname>paimon::PredicateBuilder::In</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::vector&lt; <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &gt; &amp;</type>
<declname>literals</declname>
</param>
<briefdescription>
<para>Create an IN predicate (field IN (literal1, literal2, ...)). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value matches any of the provided literal values. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="89" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1afcc45597a0e47537347b1d95ec060bac" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::NotIn</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const std::vector&lt; Literal &gt; &amp;literals)</argsstring>
<name>NotIn</name>
<qualifiedname>paimon::PredicateBuilder::NotIn</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::vector&lt; <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &gt; &amp;</type>
<declname>literals</declname>
</param>
<briefdescription>
<para>Create a NOT IN predicate (field NOT IN (literal1, literal2, ...)). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value does not match any of the provided literal values. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="96" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1ae678da9748d294dfab12984d84f12edb" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type>std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt;</type>
<definition>static std::shared_ptr&lt; Predicate &gt; paimon::PredicateBuilder::Between</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;included_lower_bound, const Literal &amp;included_upper_bound)</argsstring>
<name>Between</name>
<qualifiedname>paimon::PredicateBuilder::Between</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>included_lower_bound</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>included_upper_bound</declname>
</param>
<briefdescription>
<para>Create a BETWEEN predicate (field BETWEEN lower_bound AND upper_bound). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value falls within the specified range (inclusive on both ends).</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>field_index</parametername>
</parameternamelist>
<parameterdescription>
<para>The index of the field in read schema (0-based). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>field_name</parametername>
</parameternamelist>
<parameterdescription>
<para>The name of the field. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>field_type</parametername>
</parameternamelist>
<parameterdescription>
<para>The data type of the field. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>included_lower_bound</parametername>
</parameternamelist>
<parameterdescription>
<para>The lower bound of the range (inclusive). </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>included_upper_bound</parametername>
</parameternamelist>
<parameterdescription>
<para>The upper bound of the range (inclusive). </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="109" column="28"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a28edb189c9277ddb4c6f45c74c19d8d6" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::And</definition>
<argsstring>(const std::vector&lt; std::shared_ptr&lt; Predicate &gt; &gt; &amp;predicates)</argsstring>
<name>And</name>
<qualifiedname>paimon::PredicateBuilder::And</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::vector&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt; &amp;</type>
<declname>predicates</declname>
</param>
<briefdescription>
<para>Create an AND predicate combining multiple predicates. </para>
</briefdescription>
<detaileddescription>
<para>Creates a logical AND operation that evaluates to true only when all input predicates evaluate to true.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>predicates</parametername>
</parameternamelist>
<parameterdescription>
<para>A vector of shared pointers to the predicates, which must not be empty. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="120" column="19"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a8a789383742a200473ad9bb25cb22b55" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::Or</definition>
<argsstring>(const std::vector&lt; std::shared_ptr&lt; Predicate &gt; &gt; &amp;predicates)</argsstring>
<name>Or</name>
<qualifiedname>paimon::PredicateBuilder::Or</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::vector&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt; &amp;</type>
<declname>predicates</declname>
</param>
<briefdescription>
<para>Create an OR predicate combining multiple predicates. </para>
</briefdescription>
<detaileddescription>
<para>Creates a logical OR operation that evaluates to true when at least one of the input predicates evaluates to true.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>predicates</parametername>
</parameternamelist>
<parameterdescription>
<para>A vector of shared pointers to the predicates, which must not be empty. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="129" column="19"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a96d1c878e7fa2c37ace09c08b7d414e9" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::Not</definition>
<argsstring>(const std::shared_ptr&lt; Predicate &gt; &amp;predicate)</argsstring>
<name>Not</name>
<qualifiedname>paimon::PredicateBuilder::Not</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &amp;</type>
<declname>predicate</declname>
</param>
<briefdescription>
<para>Create a NOT predicate negating the result of another predicate. </para>
</briefdescription>
<detaileddescription>
<para>Creates a logical NOT operation that inverts the truth value of the input predicate.</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>predicate</parametername>
</parameternamelist>
<parameterdescription>
<para>A shared pointer to the predicate to be negated, which must not be nullptr. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="137" column="19"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a445d5eadca4c8ceb7394228dceea7981" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::StartsWith</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>StartsWith</name>
<qualifiedname>paimon::PredicateBuilder::StartsWith</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a starts-with predicate (field like &apos;abc&apos; or field like &apos;abc_&apos;). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value starts with the provided literal value. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="142" column="19"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1a796781d234df7ff135bbb6901c4ef1f4" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::EndsWith</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>EndsWith</name>
<qualifiedname>paimon::PredicateBuilder::EndsWith</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create an ends-with predicate (field like &apos;abc&apos; or field like &apos;_abc&apos;). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value ends with the provided literal value. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="150" column="19"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1acdbbd91a833f80df80513be2fa7aaeb3" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::Contains</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>Contains</name>
<qualifiedname>paimon::PredicateBuilder::Contains</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a contains predicate (field like &apos;abc&apos;). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value contains the provided literal value. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="158" column="19"/>
</memberdef>
<memberdef kind="function" id="classpaimon_1_1_predicate_builder_1ad2ee2223fe7e431210baeb8e632189be" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
<type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>&lt; std::shared_ptr&lt; <ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref> &gt; &gt;</type>
<definition>static Result&lt; std::shared_ptr&lt; Predicate &gt; &gt; paimon::PredicateBuilder::Like</definition>
<argsstring>(int32_t field_index, const std::string &amp;field_name, const FieldType &amp;field_type, const Literal &amp;literal)</argsstring>
<name>Like</name>
<qualifiedname>paimon::PredicateBuilder::Like</qualifiedname>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type>
<declname>field_index</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &amp;</type>
<declname>field_name</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="namespacepaimon_1aa6dc6701f497b96add0b6d7a5d6497f7" kindref="member">FieldType</ref> &amp;</type>
<declname>field_type</declname>
</param>
<param>
<type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> <ref refid="classpaimon_1_1_literal" kindref="compound">Literal</ref> &amp;</type>
<declname>literal</declname>
</param>
<briefdescription>
<para>Create a like predicate (field like literal). </para>
</briefdescription>
<detaileddescription>
<para>Tests whether the field value like the provided literal value. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="166" column="19"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>A utility class to create <computeroutput><ref refid="classpaimon_1_1_predicate" kindref="compound">Predicate</ref></computeroutput> object for common filter conditions. </para>
</briefdescription>
<detaileddescription>
<para><ref refid="classpaimon_1_1_predicate_builder" kindref="compound">PredicateBuilder</ref> provides static factory methods to create various types of predicates that can be used for filtering data in Paimon tables. </para>
</detaileddescription>
<location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" line="37" column="1" bodyfile="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/predicate/predicate_builder.h" bodystart="37" bodyend="170"/>
<listofallmembers>
<member refid="classpaimon_1_1_predicate_builder_1a28edb189c9277ddb4c6f45c74c19d8d6" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>And</name></member>
<member refid="classpaimon_1_1_predicate_builder_1ae678da9748d294dfab12984d84f12edb" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>Between</name></member>
<member refid="classpaimon_1_1_predicate_builder_1acdbbd91a833f80df80513be2fa7aaeb3" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>Contains</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a796781d234df7ff135bbb6901c4ef1f4" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>EndsWith</name></member>
<member refid="classpaimon_1_1_predicate_builder_1af7c0b087116a2be113c7c2f1f87f9ce6" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>Equal</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a69db050634bfe031d9ea47d067894600" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>GreaterOrEqual</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a6e38bfeaa61e4e22dad2986d0cc03c40" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>GreaterThan</name></member>
<member refid="classpaimon_1_1_predicate_builder_1ab77c27dba229ac890edc7b15124442dc" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>In</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a94b46109726bd4cb8ad191238db9ac9e" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>IsNotNull</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a7a2e26287726a9afa045c42ca55b53c1" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>IsNull</name></member>
<member refid="classpaimon_1_1_predicate_builder_1aa78d85ca6da23d9ac47aaa4bd2aa20a7" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>LessOrEqual</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a14bb8fb3e5852ec0a45619e69dd510c9" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>LessThan</name></member>
<member refid="classpaimon_1_1_predicate_builder_1ad2ee2223fe7e431210baeb8e632189be" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>Like</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a96d1c878e7fa2c37ace09c08b7d414e9" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>Not</name></member>
<member refid="classpaimon_1_1_predicate_builder_1aa11272547168a86576a88c948a16b64f" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>NotEqual</name></member>
<member refid="classpaimon_1_1_predicate_builder_1afcc45597a0e47537347b1d95ec060bac" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>NotIn</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a8a789383742a200473ad9bb25cb22b55" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>Or</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a25a7430e29c0b20d3e8f71cbfcb17592" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>PredicateBuilder</name></member>
<member refid="classpaimon_1_1_predicate_builder_1a445d5eadca4c8ceb7394228dceea7981" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>StartsWith</name></member>
<member refid="classpaimon_1_1_predicate_builder_1abe75fa206dea6ccc1fbe472a164c5349" prot="public" virt="non-virtual"><scope>paimon::PredicateBuilder</scope><name>~PredicateBuilder</name></member>
</listofallmembers>
</compounddef>
</doxygen>