> ## 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.

# gpudbrecord

> gpudbrecord — Kinetica Python API

<div className="kinetica-pydoc">
  <div itemprop="articleBody">
    <div id="class-gpudbrecord" className="section">
      <h1>Class GPUdbRecord</h1>

      <div className="dl py class">
        <div className="dt sig sig-object py" id="gpudb.GPUdbRecord"> <span className="em property"><span className="k"><span className="pre">class</span></span><span className="w"> </span></span><span className="sig-prename descclassname"><span className="pre">gpudb.</span></span><span className="sig-name descname"><span className="pre">GPUdbRecord</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">record\_type</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">column\_values</span></span></span><span className="sig-paren">)</span></div>

        <div className="dd">
          <p>Represent the data for a given record in GPUdb. Has convenience functions for encoding/decoding the data.</p>
          <p>Create a GPUdbRecord object which holds the data for a given record.</p>
          <p><strong>Parameters</strong></p>

          <blockquote>
            <div>
              <div className="dl simple">
                <div className="dt">record\_type (<span className="em">GPUdbRecordType</span>) –</div>

                <div className="dd">
                  <p>A <a className="reference internal" href="/content/api/python/source/gpudbrecordtype#gpudb.GPUdbRecordType" title="gpudb.GPUdbRecordType"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbRecordType</span></code></a> object that describes the columns of this record.</p>
                </div>

                <div className="dt">column\_values (<span className="em">dict or list</span>) –</div>

                <div className="dd">
                  <p>Either a dict or a list that contains the values for the columns. In either case, must contain values for ALL columns. If a list, then the columns must be in the correct order.</p>
                </div>
              </div>
            </div>
          </blockquote>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.decode_binary_data"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">decode\_binary\_data</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">record\_type</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">binary\_data</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Decode binary encoded data (generally returned by GPUdb) using the schema for the data. Return the decoded data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">record\_type (<span className="em">str or RecordType</span>) –</div>

                    <div className="dd">
                      <p>If string, then the schema string for the record type, or a <code className="xref py py-class docutils literal notranslate"><span className="pre">RecordType</span></code> object representing the type.</p>
                    </div>

                    <div className="dt">binary\_data (<span className="em">obj or list</span>) –</div>

                    <div className="dd">
                      <p>The binary encoded data. Could be a single object or a list of data.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>The decoded data (<span className="em">a single object or a list</span>)</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.decode_dynamic_binary_data"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">decode\_dynamic\_binary\_data</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">record\_type</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">binary\_data</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Decode binary encoded data (generally returned by GPUdb) using the schema for the data. Return the decoded data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">record\_type (<span className="em">str or RecordType</span>) –</div>

                    <div className="dd">
                      <p>If string, then the schema string for the record type, or a <code className="xref py py-class docutils literal notranslate"><span className="pre">RecordType</span></code> object representing the type.</p>
                    </div>

                    <div className="dt">binary\_data (<span className="em">obj or list</span>) –</div>

                    <div className="dd">
                      <p>The binary encoded data. Could be a single object or a list of data.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>The decoded data (<span className="em">a single object or a list</span>)</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.decode_json_string_data"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">decode\_json\_string\_data</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">json\_string\_data</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Decode binary encoded data in string form (generally returned by GPUdb). Return the decoded data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">json\_string\_data (<span className="em">str</span>) –</div>

                    <div className="dd">
                      <p>The stringified JSON encoded data. Could be a single object or a list of data.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>The decoded data (<span className="em">a single object or a list</span>)</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.decode_dynamic_json_data_column_major"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">decode\_dynamic\_json\_data\_column\_major</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">dynamic\_json\_data</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">dynamic\_schema</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Decode JSON encoded data (generally returned by GPUdb) using the embedded dynamic schema for the data. Return the decoded data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">dynamic\_json\_data (<span className="em">dict</span>) –</div>

                    <div className="dd">
                      <p>The JSON encoded data with a dynamic schema.</p>
                    </div>

                    <div className="dt">dynamic\_schema (<span className="em">str</span>) –</div>

                    <div className="dd">
                      <p>The schema string for the data</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>The decoded data (<span className="em">a single object or a list</span>)</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.decode_dynamic_json_data_row_major"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">decode\_dynamic\_json\_data\_row\_major</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">dynamic\_json\_data</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">dynamic\_schema</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Decode JSON encoded data (generally returned by GPUdb) using the embedded dynamic schema for the data. Return the decoded data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">dynamic\_json\_data (<span className="em">dict</span>) –</div>

                    <div className="dd">
                      <p>The JSON encoded data with a dynamic schema.</p>
                    </div>

                    <div className="dt">dynamic\_schema (<span className="em">str</span>) –</div>

                    <div className="dd">
                      <p>The schema string for the data</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>The decoded data in row-format (<span className="em">a single object or a list</span>)</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.convert_data_col_major_to_row_major"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">convert\_data\_col\_major\_to\_row\_major</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">col\_major\_data</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">col\_major\_schema\_str</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Given some column major data, convert it to row major data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">col\_major\_data (<span className="em">OrderedDict</span>) –</div>

                    <div className="dd">
                      <p>An OrderedDict of arrays containing the data by column names.</p>
                    </div>

                    <div className="dt">col\_major\_schema\_str (<span className="em">str</span>) –</div>

                    <div className="dd">
                      <p>A JSON schema string describing the column major data.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>A list of GPUdbRecord objects.</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.transpose_data_to_col_major"> <span className="em property"><span className="k"><span className="pre">static</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">transpose\_data\_to\_col\_major</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">row\_major\_data</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Given some row major data, convert it to column major data.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">row\_major\_data (list of <code className="xref py py-class docutils literal notranslate"><span className="pre">Record</span></code> or collections.OrderedDicts) –</div>

                    <div className="dd">
                      <p>A list of <code className="xref py py-class docutils literal notranslate"><span className="pre">Record</span></code> or collections.OrderedDicts objects containing the data.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>A dict of lists where the keys are column names and the values are –</p>
                  <p>lists (<span className="em">containing the values for the pertinent column of all the records</span>)</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.record_type"> <span className="em property"><span className="k"><span className="pre">property</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">record\_type</span></span></div>

            <div className="dd">
              <p>The type for this record.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.column_values"> <span className="em property"><span className="k"><span className="pre">property</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">column\_values</span></span></div>

            <div className="dd">
              <p>The values for this record.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.data"> <span className="em property"><span className="k"><span className="pre">property</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">data</span></span></div>

            <div className="dd">
              <p>The values for this record.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.binary_data"> <span className="em property"><span className="k"><span className="pre">property</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">binary\_data</span></span></div>

            <div className="dd">
              <p>The binary encoded values for this record.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.json_data_string"> <span className="em property"><span className="k"><span className="pre">property</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">json\_data\_string</span></span></div>

            <div className="dd">
              <p>The stringified JSON encoded values for this record.</p>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.keys"> <span className="sig-name descname"><span className="pre">keys</span></span><span className="sig-paren">(</span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Return a list of the column names of the record.</p>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.values"> <span className="sig-name descname"><span className="pre">values</span></span><span className="sig-paren">(</span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Return a list of the values of the record.</p>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecord.insert_record"> <span className="sig-name descname"><span className="pre">insert\_record</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">gpudb</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">table\_name</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">encoding</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">'binary'</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Insert this record into GPUdb.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">gpudb (<span className="em">GPUdb</span>) –</div>

                    <div className="dd">
                      <p>A <a className="reference internal" href="/content/api/python/source/gpudb#gpudb.GPUdb" title="gpudb.GPUdb"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdb</span></code></a> client handle.</p>
                    </div>

                    <div className="dt">table\_name (<span className="em">str</span>) –</div>

                    <div className="dd">
                      <p>The name of the table into which we need to insert the record.</p>
                    </div>

                    <div className="dt">encoding (<span className="em">str</span>) –</div>

                    <div className="dd">
                      <p>Optional encoding with which to perform the insertion. Default is binary encoding.</p>
                    </div>

                    <div className="dt">options (<span className="em">dict</span>) –</div>

                    <div className="dd">
                      <p>Optional parameter. If given, use the options for the insertion function.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

              <p><strong>Returns</strong></p>

              <blockquote>
                <div>
                  <p>The response from GPUdb.</p>
                </div>
              </blockquote>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>
