> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# insertRecords

<div className="kinetica-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="insertRecords(com.gpudb.protocol.InsertRecordsRequest)">
        <h3>insertRecords</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="type-parameters">\<TRequest></span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol">InsertRecordsResponse</a></span> <span className="element-name">insertRecords</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest" title="class in com.gpudb.protocol">InsertRecordsRequest</a>\<TRequest> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest#getOptions()"><code>options</code></a> parameter can be used to customize this function's behavior. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> option specifies the record collision policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>, but is ignored if no primary key exists. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_RECORD_IDS"><code>RETURN\_RECORD\_IDS</code></a> option indicates that the database should return the unique identifiers of inserted records.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Type Parameters:</div>
          <div className="dd"><code>TRequest</code> - The type of object being added.</div>
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="insertRecords(com.gpudb.TypeObjectMap,com.gpudb.protocol.InsertRecordsRequest)">
        <h3>insertRecords</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="type-parameters">\<TRequest></span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol">InsertRecordsResponse</a></span> <span className="element-name">insertRecords</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<TRequest> typeObjectMap, <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest" title="class in com.gpudb.protocol">InsertRecordsRequest</a>\<TRequest> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest#getOptions()"><code>options</code></a> parameter can be used to customize this function's behavior. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> option specifies the record collision policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>, but is ignored if no primary key exists. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_RECORD_IDS"><code>RETURN\_RECORD\_IDS</code></a> option indicates that the database should return the unique identifiers of inserted records.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Type Parameters:</div>
          <div className="dd"><code>TRequest</code> - The type of object being added.</div>
          <div className="dt">Parameters:</div>
          <div className="dd"><code>typeObjectMap</code> - Type object map used for encoding input objects.</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if <code>typeObjectMap</code> is not an instance of one of the following: <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a>, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb"><code>TypeObjectMap</code></a>, <code>Schema</code>, or a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" className="external-link"><code>Class</code></a> that implements <code>IndexedRecord</code></div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="insertRecords(java.lang.String,java.util.List,java.util.Map)">
        <h3>insertRecords</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="type-parameters">\<TRequest></span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol">InsertRecordsResponse</a></span> <span className="element-name">insertRecords</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<TRequest> data, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
          <p> The <code>options</code> parameter can be used to customize this function's behavior. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> option specifies the record collision policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>, but is ignored if no primary key exists. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_RECORD_IDS"><code>RETURN\_RECORD\_IDS</code></a> option indicates that the database should return the unique identifiers of inserted records.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Type Parameters:</div>
          <div className="dd"><code>TRequest</code> - The type of object being added.</div>
          <div className="dt">Parameters:</div>
          <div className="dd"><code>tableName</code> - Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>
          <div className="dd"><code>data</code> - An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if <code>listEncoding</code> is <code>JSON</code>.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a>: Specifies the record collision policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>. If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#IGNORE_EXISTING_PK"><code>IGNORE\_EXISTING\_PK</code></a>, <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a>, and <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_INDIVIDUAL_ERRORS"><code>RETURN\_INDIVIDUAL\_ERRORS</code></a>. If the specified table does not have a primary key, then this option has no effect. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>: Upsert new records when primary keys match existing records. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>: Reject new records when primary keys match existing records. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ENABLE_INPLACE_UPDATES"><code>ENABLE\_INPLACE\_UPDATES</code></a>: Applies only when upserting (when <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>). If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, an existing record matched by primary key is modified in place. If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#IGNORE_EXISTING_PK"><code>IGNORE\_EXISTING\_PK</code></a>: Specifies the record collision error-suppression policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>, only used when not in upsert mode (upsert mode is disabled when <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>). If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a> and <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_INDIVIDUAL_ERRORS"><code>RETURN\_INDIVIDUAL\_ERRORS</code></a>. If the specified table does not have a primary key or if upsert mode is in effect (<a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>), then this option has no effect. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>: Ignore new records whose primary key values collide with those of existing records. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>: Treat as errors any new records whose primary key values collide with those of existing records. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#PK_CONFLICT_PREDICATE_HIGHER"><code>PK\_CONFLICT\_PREDICATE\_HIGHER</code></a>: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#PK_CONFLICT_PREDICATE_LOWER"><code>PK\_CONFLICT\_PREDICATE\_LOWER</code></a>: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''. </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_RECORD_IDS"><code>RETURN\_RECORD\_IDS</code></a>: If <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> then return the internal record id along for each inserted record. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUNCATE_STRINGS"><code>TRUNCATE\_STRINGS</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, any strings which are too long for their target charN string columns will be truncated to fit. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_INDIVIDUAL_ERRORS"><code>RETURN\_INDIVIDUAL\_ERRORS</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ERROR_HANDLING"><code>ERROR\_HANDLING</code></a>: Specifies how errors should be handled upon insertion. When set, this option is authoritative; supplying a contradictory <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a> is an error. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#PERMISSIVE"><code>PERMISSIVE</code></a>: Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#SKIP"><code>SKIP</code></a>: Records with bad values are skipped and reported; the rest of the batch is inserted. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ABORT"><code>ABORT</code></a>: Stops the insertion and rejects the remaining batch when any record is incorrect. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ABORT"><code>ABORT</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, no data will be saved and any errors will be returned. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#REQUEST_SCHEMA_STR"><code>REQUEST\_SCHEMA\_STR</code></a>: Type schema of <code> data</code> (when <code>listEncoding</code> is <code> BINARY</code>), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRANSFORMATIONS"><code>TRANSFORMATIONS</code></a>: Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column -- the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''. </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="insertRecords(com.gpudb.TypeObjectMap,java.lang.String,java.util.List,java.util.Map)">
        <h3>insertRecords</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="type-parameters">\<TRequest></span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol">InsertRecordsResponse</a></span> <span className="element-name">insertRecords</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<TRequest> typeObjectMap, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<TRequest> data, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

        <div className="block">
          Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
          <p> The <code>options</code> parameter can be used to customize this function's behavior. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> option specifies the record collision policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>, but is ignored if no primary key exists. </p>
          <p> The <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_RECORD_IDS"><code>RETURN\_RECORD\_IDS</code></a> option indicates that the database should return the unique identifiers of inserted records.</p>
        </div>

        <div className="dl notes">
          <div className="dt">Type Parameters:</div>
          <div className="dd"><code>TRequest</code> - The type of object being added.</div>
          <div className="dt">Parameters:</div>
          <div className="dd"><code>typeObjectMap</code> - Type object map used for encoding input objects.</div>
          <div className="dd"><code>tableName</code> - Name of table to which the records are to be added, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>
          <div className="dd"><code>data</code> - An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if <code>listEncoding</code> is <code>JSON</code>.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a>: Specifies the record collision policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>. If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#IGNORE_EXISTING_PK"><code>IGNORE\_EXISTING\_PK</code></a>, <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a>, and <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_INDIVIDUAL_ERRORS"><code>RETURN\_INDIVIDUAL\_ERRORS</code></a>. If the specified table does not have a primary key, then this option has no effect. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>: Upsert new records when primary keys match existing records. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>: Reject new records when primary keys match existing records. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ENABLE_INPLACE_UPDATES"><code>ENABLE\_INPLACE\_UPDATES</code></a>: Applies only when upserting (when <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>). If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, an existing record matched by primary key is modified in place. If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>, it is updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#IGNORE_EXISTING_PK"><code>IGNORE\_EXISTING\_PK</code></a>: Specifies the record collision error-suppression policy for inserting into a table with a <a href="/content/concepts/tables/#primary-keys" target="_top">primary key</a>, only used when not in upsert mode (upsert mode is disabled when <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>). If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a> and <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_INDIVIDUAL_ERRORS"><code>RETURN\_INDIVIDUAL\_ERRORS</code></a>. If the specified table does not have a primary key or if upsert mode is in effect (<a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#UPDATE_ON_EXISTING_PK"><code>UPDATE\_ON\_EXISTING\_PK</code></a> is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>), then this option has no effect. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>: Ignore new records whose primary key values collide with those of existing records. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>: Treat as errors any new records whose primary key values collide with those of existing records. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#PK_CONFLICT_PREDICATE_HIGHER"><code>PK\_CONFLICT\_PREDICATE\_HIGHER</code></a>: The record with higher value for the column resolves the primary-key insert conflict. The default value is ''. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#PK_CONFLICT_PREDICATE_LOWER"><code>PK\_CONFLICT\_PREDICATE\_LOWER</code></a>: The record with lower value for the column resolves the primary-key insert conflict. The default value is ''. </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_RECORD_IDS"><code>RETURN\_RECORD\_IDS</code></a>: If <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> then return the internal record id along for each inserted record. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUNCATE_STRINGS"><code>TRUNCATE\_STRINGS</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, any strings which are too long for their target charN string columns will be truncated to fit. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#RETURN_INDIVIDUAL_ERRORS"><code>RETURN\_INDIVIDUAL\_ERRORS</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, success will always be returned, and any errors found will be included in the info map. The "bad\_record\_indices" entry is a comma-separated list of bad records (0-based). If so, there will also be an "error\_N" entry for each record with an error, where N is the index (0-based). Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ERROR_HANDLING"><code>ERROR\_HANDLING</code></a>: Specifies how errors should be handled upon insertion. When set, this option is authoritative; supplying a contradictory <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ALLOW_PARTIAL_BATCH"><code>ALLOW\_PARTIAL\_BATCH</code></a> is an error. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#PERMISSIVE"><code>PERMISSIVE</code></a>: Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#SKIP"><code>SKIP</code></a>: Records with bad values are skipped and reported; the rest of the batch is inserted. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ABORT"><code>ABORT</code></a>: Stops the insertion and rejects the remaining batch when any record is incorrect. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#ABORT"><code>ABORT</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If set to <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a>, no data will be saved and any errors will be returned. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#REQUEST_SCHEMA_STR"><code>REQUEST\_SCHEMA\_STR</code></a>: Type schema of <code> data</code> (when <code>listEncoding</code> is <code> BINARY</code>), in \[\["{"{"}column\_name{"}"}","{"{"}column\_type{"}"}"]] format. When non-empty and different from the table's schema, the server remaps the incoming records to the table's full schema. Columns present in the table but absent from this schema are filled using their default values, NULL (if nullable), or an error is returned. If empty, records must match the table's full schema. The default value is ''. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/InsertRecordsRequest.Options#TRANSFORMATIONS"><code>TRANSFORMATIONS</code></a>: Comma-separated expressions, one per target table column. Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column -- the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position ($1 for the first input column, $2 for the second, etc.). The default value is ''. </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/InsertRecordsResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if <code>typeObjectMap</code> is not an instance of one of the following: <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a>, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb"><code>TypeObjectMap</code></a>, <code>Schema</code>, or a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" className="external-link"><code>Class</code></a> that implements <code>IndexedRecord</code></div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>
