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

# gpudbrecordtype

> gpudbrecordtype — Kinetica Python API

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

      <div className="dl py class">
        <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType"> <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">GPUdbRecordType</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">columns</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">List</span><span className="p"><span className="pre">\[</span></span><a className="reference internal" href="/content/api/python/source/gpudbrecordcolumn#gpudb.GPUdbRecordColumn" title="gpudb.GPUdbRecordColumn"><span className="pre">GPUdbRecordColumn</span></a><span className="p"><span className="pre">]</span></span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">label</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">''</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">schema\_string</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">column\_properties</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">List</span><span className="p"><span className="pre">\[</span></span><span className="pre">str</span><span className="p"><span className="pre">]</span></span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">None</span></span></span><span className="sig-paren">)</span></div>

        <div className="dd">
          <p>Represent the data type for a given record in GPUdb. Has convenience functions for creating the type in GPUdb (among others).</p>
          <p>Create a GPUdbRecordType object which represents the data type for a given record for GPUdb.</p>
          <p><strong>Parameters</strong></p>

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

                <div className="dd">
                  <p>A list of <a className="reference internal" href="/content/api/python/source/gpudbrecordcolumn#gpudb.GPUdbRecordColumn" title="gpudb.GPUdbRecordColumn"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbRecordColumn</span></code></a> objects. Either this argument or the schema\_string argument must be given.</p>
                </div>

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

                <div className="dd">
                  <p>Optional string label for the column.</p>
                </div>

                <div className="dt">schema\_string (<span className="em">str</span>) –</div>

                <div className="dd">
                  <p>The JSON string containing the schema for the type. Either this argument or the columns argument must be given.</p>
                </div>

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

                <div className="dd">
                  <p>Optional dict that lists the properties for the columns of the type. Meant to be used in conjunction with schema\_string only; will be ignored if columns is given.</p>
                </div>
              </div>
            </div>
          </blockquote>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.columns"> <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">columns</span></span></div>

            <div className="dd">
              <p>A list of columns for the record type.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.column_names"> <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\_names</span></span></div>

            <div className="dd">
              <p>A list of the names of the columns for the record type.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.label"> <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">label</span></span></div>

            <div className="dd">
              <p>A label for the record type.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.schema_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">schema\_string</span></span></div>

            <div className="dd">
              <p>The schema string for the record type.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.record_schema"> <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\_schema</span></span></div>

            <div className="dd">
              <p>The avro schema for the record type.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.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 RecordType object for the record type.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.column_properties"> <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\_properties</span></span></div>

            <div className="dd">
              <p>The properties for the type’s columns.</p>
            </div>
          </div>

          <div className="dl py property">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.type_id"> <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">type\_id</span></span></div>

            <div className="dd">
              <p>The ID for the type, if it has already been registered with GPUdb.</p>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.create_type"> <span className="sig-name descname"><span className="pre">create\_type</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">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>Create the record type in GPUdb so that users can create tables using this type.</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 GPUdb object to connect to a GPUdb server.</p>
                    </div>

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

                    <div className="dd">
                      <p>Optional dictionary containing options for the /create/type call.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

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

              <blockquote>
                <div>
                  <p>The type ID.</p>
                </div>
              </blockquote>
            </div>
          </div>

          <div className="dl py method">
            <div className="dt sig sig-object py" id="gpudb.GPUdbRecordType.get_column"> <span className="sig-name descname"><span className="pre">get\_column</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">column\_id</span></span></span><span className="sig-paren">)</span></div>

            <div className="dd">
              <p>Return the desired column; fetch by name or index.</p>
              <p><strong>Parameters</strong></p>

              <blockquote>
                <div>
                  <div className="dl simple">
                    <div className="dt">column\_id (<span className="em">str or int</span>) –</div>

                    <div className="dd">
                      <p>If string, then the name of the column. If an integer, then the index of the column. Must be a valid column name or be within bounds.</p>
                    </div>
                  </div>
                </div>
              </blockquote>

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

              <blockquote>
                <div>
                  <p>The GPUdbRecordColumn object pertaining to the desired column.</p>
                </div>
              </blockquote>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>