Skip to content

Commit 2a4767d

Browse files
committed
deploy: e938b29
1 parent 0c1cf20 commit 2a4767d

15 files changed

Lines changed: 41 additions & 7 deletions

.doctrees/all-modules.doctree

8.63 KB
Binary file not shown.

.doctrees/environment.pickle

636 Bytes
Binary file not shown.

all-modules.html

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,7 @@
838838
<li class="toctree-l3"><a class="reference internal" href="#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
839839
<li class="toctree-l3"><a class="reference internal" href="#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
840840
<li class="toctree-l3"><a class="reference internal" href="#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
841+
<li class="toctree-l3"><a class="reference internal" href="#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
841842
<li class="toctree-l3"><a class="reference internal" href="#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
842843
<li class="toctree-l3"><a class="reference internal" href="#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
843844
<li class="toctree-l3"><a class="reference internal" href="#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>
@@ -10629,6 +10630,28 @@ <h2>Exceptions<a class="headerlink" href="#exceptions" title="Link to this headi
1062910630
<span class="sig-name descname"><span class="pre">column_indices</span></span><span class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.14)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span><a class="headerlink" href="#id67" title="Link to this definition"></a></dt>
1063010631
<dd></dd></dl>
1063110632

10633+
<dl class="py method">
10634+
<dt class="sig sig-object py" id="lance.fragment.DataFile.create">
10635+
<span class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#lance.LanceDataset" title="lance.LanceDataset"><span class="pre">LanceDataset</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#lance.fragment.DataFile" title="lance.fragment.DataFile"><span class="pre">DataFile</span></a></span></span><a class="headerlink" href="#lance.fragment.DataFile.create" title="Link to this definition"></a></dt>
10636+
<dd><p>Create a DataFile by reading metadata from an existing lance file.</p>
10637+
<p>This is a convenience method for creating DataFile metadata needed
10638+
for operations like DataReplacement. It opens the file, reads its
10639+
schema and version information, matches columns to the dataset’s
10640+
schema to determine field IDs, and calculates column indices.</p>
10641+
<dl class="field-list simple">
10642+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
10643+
<dd class="field-odd"><ul class="simple">
10644+
<li><p><strong>dataset</strong> (<a class="reference internal" href="#lance.LanceDataset" title="lance.LanceDataset"><em>LanceDataset</em></a>) – The dataset this file will belong to.</p></li>
10645+
<li><p><strong>path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The path to the data file, relative to the dataset’s data directory.</p></li>
10646+
<li><p><strong>base_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>, </em><em>optional</em>) – The base path ID if the file is outside the dataset directory.</p></li>
10647+
</ul>
10648+
</dd>
10649+
<dt class="field-even">Return type<span class="colon">:</span></dt>
10650+
<dd class="field-even"><p><a class="reference internal" href="#lance.fragment.DataFile" title="lance.fragment.DataFile">DataFile</a></p>
10651+
</dd>
10652+
</dl>
10653+
</dd></dl>
10654+
1063210655
<dl class="py method">
1063310656
<dt class="sig sig-object py" id="lance.fragment.DataFile.field_ids">
1063410657
<span class="sig-name descname"><span class="pre">field_ids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.14)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#lance.fragment.DataFile.field_ids" title="Link to this definition"></a></dt>

basic-io.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,7 @@
839839
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
840840
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
841841
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
842+
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
842843
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
843844
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
844845
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>

data-evolution.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,7 @@
839839
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
840840
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
841841
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
842+
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
842843
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
843844
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
844845
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>

dataset.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,7 @@
839839
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
840840
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
841841
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
842+
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
842843
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
843844
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
844845
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>

genindex.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -836,6 +836,7 @@
836836
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
837837
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
838838
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
839+
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
839840
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
840841
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
841842
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>
@@ -1195,6 +1196,8 @@ <h2 id="C">C</h2>
11951196
<li><a href="all-modules.html#lance.dataset.Tags.create">create() (lance.dataset.Tags method)</a>
11961197

11971198
<ul>
1199+
<li><a href="all-modules.html#lance.fragment.DataFile.create">(lance.fragment.DataFile class method)</a>
1200+
</li>
11981201
<li><a href="all-modules.html#lance.fragment.LanceFragment.create">(lance.fragment.LanceFragment static method)</a>
11991202
</li>
12001203
<li><a href="all-modules.html#lance.LanceFragment.create">(lance.LanceFragment static method)</a>

index-and-search.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,7 @@
839839
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
840840
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
841841
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
842+
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
842843
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
843844
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
844845
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>

index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -838,6 +838,7 @@
838838
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.file_size_bytes"><code class="docutils literal notranslate"><span class="pre">DataFile.file_size_bytes</span></code></a></li>
839839
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.base_id"><code class="docutils literal notranslate"><span class="pre">DataFile.base_id</span></code></a></li>
840840
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id67"><code class="docutils literal notranslate"><span class="pre">DataFile.column_indices</span></code></a></li>
841+
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.create"><code class="docutils literal notranslate"><span class="pre">DataFile.create()</span></code></a></li>
841842
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#lance.fragment.DataFile.field_ids"><code class="docutils literal notranslate"><span class="pre">DataFile.field_ids()</span></code></a></li>
842843
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id68"><code class="docutils literal notranslate"><span class="pre">DataFile.fields</span></code></a></li>
843844
<li class="toctree-l3"><a class="reference internal" href="all-modules.html#id69"><code class="docutils literal notranslate"><span class="pre">DataFile.file_major_version</span></code></a></li>

objects.inv

3 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)