| <?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_write_context_builder" kind="class" language="C++" prot="public"> |
| <compoundname>paimon::WriteContextBuilder</compoundname> |
| <includes refid="write__context_8h" local="no">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h</includes> |
| <sectiondef kind="private-attrib"> |
| <memberdef kind="variable" id="classpaimon_1_1_write_context_builder_1ae3a74e72a038ca11ecbbd0ae032f5bf8" prot="private" static="no" mutable="no"> |
| <type>std::unique_ptr< <ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">Impl</ref> ></type> |
| <definition>std::unique_ptr<Impl> paimon::WriteContextBuilder::impl_</definition> |
| <argsstring></argsstring> |
| <name>impl_</name> |
| <qualifiedname>paimon::WriteContextBuilder::impl_</qualifiedname> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="246" column="21" bodyfile="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" bodystart="246" bodyend="-1"/> |
| </memberdef> |
| </sectiondef> |
| <sectiondef kind="public-func"> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a6ad9a69a9e46607f1e94d19deda365af" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type></type> |
| <definition>paimon::WriteContextBuilder::WriteContextBuilder</definition> |
| <argsstring>(const std::string &root_path, const std::string &commit_user)</argsstring> |
| <name>WriteContextBuilder</name> |
| <qualifiedname>paimon::WriteContextBuilder::WriteContextBuilder</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &</type> |
| <declname>root_path</declname> |
| </param> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &</type> |
| <declname>commit_user</declname> |
| </param> |
| <briefdescription> |
| <para>Constructs a <computeroutput><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref></computeroutput> with required parameters. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>root_path</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The root path of the table. </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>commit_user</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The user identifier for commit operations. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="139" column="5"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1aff1f3c2273a608227aa43889237c4e78" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type></type> |
| <definition>paimon::WriteContextBuilder::~WriteContextBuilder</definition> |
| <argsstring>()</argsstring> |
| <name>~WriteContextBuilder</name> |
| <qualifiedname>paimon::WriteContextBuilder::~WriteContextBuilder</qualifiedname> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="141" column="5"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a1adf3f18f8780a7da951272ae795abe5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::SetOptions</definition> |
| <argsstring>(const std::map< std::string, std::string > &options)</argsstring> |
| <name>SetOptions</name> |
| <qualifiedname>paimon::WriteContextBuilder::SetOptions</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::map< std::string, std::string > &</type> |
| <declname>options</declname> |
| </param> |
| <briefdescription> |
| <para>Set a configuration options map to set some option entries which are not defined in the table schema or whose values you want to overwrite. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><simplesect kind="note"><para>The options map will clear the options added by <computeroutput><ref refid="classpaimon_1_1_write_context_builder_1a27cdcf8737e307ec36d2590c8561ae73" kindref="member">AddOption()</ref></computeroutput> before. </para> |
| </simplesect> |
| <parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>options</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The configuration options map. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="148" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a27cdcf8737e307ec36d2590c8561ae73" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::AddOption</definition> |
| <argsstring>(const std::string &key, const std::string &value)</argsstring> |
| <name>AddOption</name> |
| <qualifiedname>paimon::WriteContextBuilder::AddOption</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &</type> |
| <declname>key</declname> |
| </param> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &</type> |
| <declname>value</declname> |
| </param> |
| <briefdescription> |
| <para>Add a single configuration option which is not defined in the table schema or whose value you want to overwrite. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>If you want to add multiple options, call <computeroutput><ref refid="classpaimon_1_1_write_context_builder_1a27cdcf8737e307ec36d2590c8561ae73" kindref="member">AddOption()</ref></computeroutput> multiple times or use <computeroutput><ref refid="classpaimon_1_1_write_context_builder_1a1adf3f18f8780a7da951272ae795abe5" kindref="member">SetOptions()</ref></computeroutput> instead. <parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>key</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The option key. </para> |
| </parameterdescription> |
| </parameteritem> |
| <parameteritem> |
| <parameternamelist> |
| <parametername>value</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The option value. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="158" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a44f08b858246970933fa263b8428983f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithStreamingMode</definition> |
| <argsstring>(bool is_streaming_mode)</argsstring> |
| <name>WithStreamingMode</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithStreamingMode</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">bool</ref></type> |
| <declname>is_streaming_mode</declname> |
| </param> |
| <briefdescription> |
| <para>Set whether to enable streaming mode (default is false) </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="162" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a05a89ef124b790b8ea61f12bf59ed60e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithIgnoreNumBucketCheck</definition> |
| <argsstring>(bool ignore_num_bucket_check)</argsstring> |
| <name>WithIgnoreNumBucketCheck</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithIgnoreNumBucketCheck</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">bool</ref></type> |
| <declname>ignore_num_bucket_check</declname> |
| </param> |
| <briefdescription> |
| <para>Set whether to skip num-bucket consistency check (default is false) </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="166" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a8e834e02efd5eb174d08e200d89908be" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithIgnorePreviousFiles</definition> |
| <argsstring>(bool ignore_previous_files)</argsstring> |
| <name>WithIgnorePreviousFiles</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithIgnorePreviousFiles</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">bool</ref></type> |
| <declname>ignore_previous_files</declname> |
| </param> |
| <briefdescription> |
| <para>Set whether the write operation should ignore previously stored files. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>(default is false) <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="170" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a27e4da341f9e6c6e3a71e97a1cb4be39" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithMemoryPool</definition> |
| <argsstring>(const std::shared_ptr< MemoryPool > &memory_pool)</argsstring> |
| <name>WithMemoryPool</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithMemoryPool</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::shared_ptr< <ref refid="classpaimon_1_1_memory_pool" kindref="compound">MemoryPool</ref> > &</type> |
| <declname>memory_pool</declname> |
| </param> |
| <briefdescription> |
| <para>Set custom memory pool for memory management. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>memory_pool</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The memory pool to use. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="175" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a2eee68bec2e79f0f0dbddff6a52711ae" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithExecutor</definition> |
| <argsstring>(const std::shared_ptr< Executor > &executor)</argsstring> |
| <name>WithExecutor</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithExecutor</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::shared_ptr< <ref refid="classpaimon_1_1_executor" kindref="compound">Executor</ref> > &</type> |
| <declname>executor</declname> |
| </param> |
| <briefdescription> |
| <para>Set custom executor for task execution. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>executor</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The executor to use. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="180" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1acf6bfdc8d1bb7c8cb12bb0dc83996947" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithTempDirectory</definition> |
| <argsstring>(const std::string &temp_dir)</argsstring> |
| <name>WithTempDirectory</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithTempDirectory</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &</type> |
| <declname>temp_dir</declname> |
| </param> |
| <briefdescription> |
| <para>Set the temporary directory path for IO operations (lookup and external disk spill). </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>temp_dir</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The temporary directory path. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="185" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1ad8028f23e6eaba79e40318ee94c2dcc5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithWriteId</definition> |
| <argsstring>(int32_t write_id)</argsstring> |
| <name>WithWriteId</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithWriteId</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type> |
| <declname>write_id</declname> |
| </param> |
| <briefdescription> |
| <para>For postpone bucket mode in pk table, <computeroutput><ref refid="classpaimon_1_1_write_context_builder_1ad8028f23e6eaba79e40318ee94c2dcc5" kindref="member">WithWriteId()</ref></computeroutput> supposed to be used. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>Each worker must have its own unique <computeroutput>write_id</computeroutput> within a task, which is used as the prefix for its data files. This ensures that files from the same worker share the same prefix and can be consumed by the same compaction reader to preserve input order.</para> |
| <para><simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="194" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a82d651fbd10b459afa53bfab69579253" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithBranch</definition> |
| <argsstring>(const std::string &branch)</argsstring> |
| <name>WithBranch</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithBranch</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::string &</type> |
| <declname>branch</declname> |
| </param> |
| <briefdescription> |
| <para>Write to specific branch, default is main. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="198" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a30d7e66dfe2f42f2b832f530f3922acb" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithWriteSchema</definition> |
| <argsstring>(const std::vector< std::string > &write_schema)</argsstring> |
| <name>WithWriteSchema</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithWriteSchema</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::vector< std::string > &</type> |
| <declname>write_schema</declname> |
| </param> |
| <briefdescription> |
| <para>For data evolution, user can write partial specific fields from table schema. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>If not set, write all fields in table. <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="203" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a6a239db57984aec089169ce18977eec3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithFileSystem</definition> |
| <argsstring>(const std::shared_ptr< FileSystem > &file_system)</argsstring> |
| <name>WithFileSystem</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithFileSystem</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::shared_ptr< <ref refid="classpaimon_1_1_file_system" kindref="compound">FileSystem</ref> > &</type> |
| <declname>file_system</declname> |
| </param> |
| <briefdescription> |
| <para>Sets a custom file system instance to be used for all file operations in this write context. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>This bypasses the global file system registry and uses the provided implementation directly.</para> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>file_system</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The file system to use. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| <simplesect kind="note"><para>If not set, use default file system (configured in <computeroutput><ref refid="structpaimon_1_1_options_1a91cdf2a3a8110ea53a0d9197d38cfae3" kindref="member">Options::FILE_SYSTEM</ref></computeroutput>) </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="211" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1ab2553c687ce23775477e9d861cd3fd70" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::WithFileSystemSchemeToIdentifierMap</definition> |
| <argsstring>(const std::map< std::string, std::string > &fs_scheme_to_identifier_map)</argsstring> |
| <name>WithFileSystemSchemeToIdentifierMap</name> |
| <qualifiedname>paimon::WriteContextBuilder::WithFileSystemSchemeToIdentifierMap</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">const</ref> std::map< std::string, std::string > &</type> |
| <declname>fs_scheme_to_identifier_map</declname> |
| </param> |
| <briefdescription> |
| <para>Sets a mapping from URI schemes (e.g., "file", "oss") to registered file system identifiers. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>This allows selecting different pre-registered file system implementations based on the URI scheme at runtime.</para> |
| <para><parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>fs_scheme_to_identifier_map</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>Map from URI scheme (like "oss") to the corresponding file system identifier. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| <simplesect kind="note"><para><itemizedlist> |
| <listitem><para>This method is intended for environments where multiple file systems are pre-registered.</para> |
| </listitem><listitem><para>The specified identifiers must correspond to file systems that have been registered at compile time or initialization.</para> |
| </listitem><listitem><para>Cannot be used together with <computeroutput><ref refid="classpaimon_1_1_write_context_builder_1a6a239db57984aec089169ce18977eec3" kindref="member">WithFileSystem()</ref></computeroutput>.</para> |
| </listitem><listitem><para>If not set, use default file system (configured in <computeroutput><ref refid="structpaimon_1_1_options_1a91cdf2a3a8110ea53a0d9197d38cfae3" kindref="member">Options::FILE_SYSTEM</ref></computeroutput>). Example: builder.WithFileSystemSchemeToIdentifierMap({{"oss", "jindo"}, {"file", "local"}}); </para> |
| </listitem></itemizedlist> |
| </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="229" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a5077992b75589880f0ad08b41caab322" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref> &</type> |
| <definition>WriteContextBuilder & paimon::WriteContextBuilder::SetWriteBufferSpillThreadNumber</definition> |
| <argsstring>(int32_t thread_number)</argsstring> |
| <name>SetWriteBufferSpillThreadNumber</name> |
| <qualifiedname>paimon::WriteContextBuilder::SetWriteBufferSpillThreadNumber</qualifiedname> |
| <param> |
| <type><ref refid="memory__pool_8h_1a147ba4ba34a215b3a4f3a95c1ee11704" kindref="member">int32_t</ref></type> |
| <declname>thread_number</declname> |
| </param> |
| <briefdescription> |
| <para>Set the thread number for write buffer spill operations. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para>(default is 0) If <= 0, threading is disabled for spill IPC read/write. If > 0, sets arrow CPU thread pool capacity for spill operations. <parameterlist kind="param"><parameteritem> |
| <parameternamelist> |
| <parametername>thread_number</parametername> |
| </parameternamelist> |
| <parameterdescription> |
| <para>The thread number to use for spill operations. </para> |
| </parameterdescription> |
| </parameteritem> |
| </parameterlist> |
| <simplesect kind="return"><para>Reference to this builder for method chaining. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="237" column="25"/> |
| </memberdef> |
| <memberdef kind="function" id="classpaimon_1_1_write_context_builder_1a6b4ea339ae0baf164b5664323f27051b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual"> |
| <type><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref>< std::unique_ptr< <ref refid="classpaimon_1_1_write_context" kindref="compound">WriteContext</ref> > ></type> |
| <definition>Result< std::unique_ptr< WriteContext > > paimon::WriteContextBuilder::Finish</definition> |
| <argsstring>()</argsstring> |
| <name>Finish</name> |
| <qualifiedname>paimon::WriteContextBuilder::Finish</qualifiedname> |
| <briefdescription> |
| <para>Build and return a <computeroutput><ref refid="classpaimon_1_1_write_context" kindref="compound">WriteContext</ref></computeroutput> instance with input validation. </para> |
| </briefdescription> |
| <detaileddescription> |
| <para><simplesect kind="return"><para><ref refid="classpaimon_1_1_result" kindref="compound">Result</ref> containing the constructed <computeroutput><ref refid="classpaimon_1_1_write_context" kindref="compound">WriteContext</ref></computeroutput> or an error status. </para> |
| </simplesect> |
| </para> |
| </detaileddescription> |
| <inbodydescription> |
| </inbodydescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="241" column="12"/> |
| </memberdef> |
| </sectiondef> |
| <briefdescription> |
| <para><computeroutput><ref refid="classpaimon_1_1_write_context_builder" kindref="compound">WriteContextBuilder</ref></computeroutput> used to build a <computeroutput><ref refid="classpaimon_1_1_write_context" kindref="compound">WriteContext</ref></computeroutput>, has input validation. </para> |
| </briefdescription> |
| <detaileddescription> |
| </detaileddescription> |
| <location file="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" line="134" column="1" bodyfile="/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/write_context.h" bodystart="134" bodyend="247"/> |
| <listofallmembers> |
| <member refid="classpaimon_1_1_write_context_builder_1a27cdcf8737e307ec36d2590c8561ae73" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>AddOption</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a6b4ea339ae0baf164b5664323f27051b" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>Finish</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1ae3a74e72a038ca11ecbbd0ae032f5bf8" prot="private" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>impl_</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a1adf3f18f8780a7da951272ae795abe5" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>SetOptions</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a5077992b75589880f0ad08b41caab322" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>SetWriteBufferSpillThreadNumber</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a82d651fbd10b459afa53bfab69579253" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithBranch</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a2eee68bec2e79f0f0dbddff6a52711ae" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithExecutor</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a6a239db57984aec089169ce18977eec3" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithFileSystem</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1ab2553c687ce23775477e9d861cd3fd70" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithFileSystemSchemeToIdentifierMap</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a05a89ef124b790b8ea61f12bf59ed60e" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithIgnoreNumBucketCheck</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a8e834e02efd5eb174d08e200d89908be" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithIgnorePreviousFiles</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a27e4da341f9e6c6e3a71e97a1cb4be39" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithMemoryPool</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a44f08b858246970933fa263b8428983f" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithStreamingMode</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1acf6bfdc8d1bb7c8cb12bb0dc83996947" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithTempDirectory</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1ad8028f23e6eaba79e40318ee94c2dcc5" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithWriteId</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a30d7e66dfe2f42f2b832f530f3922acb" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WithWriteSchema</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1a6ad9a69a9e46607f1e94d19deda365af" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>WriteContextBuilder</name></member> |
| <member refid="classpaimon_1_1_write_context_builder_1aff1f3c2273a608227aa43889237c4e78" prot="public" virt="non-virtual"><scope>paimon::WriteContextBuilder</scope><name>~WriteContextBuilder</name></member> |
| </listofallmembers> |
| </compounddef> |
| </doxygen> |
