|
128 | 128 | <li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.data_storage_version"><code class="docutils literal notranslate"><span class="pre">LanceDataset.data_storage_version</span></code></a></li> |
129 | 129 | <li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.delete"><code class="docutils literal notranslate"><span class="pre">LanceDataset.delete()</span></code></a></li> |
130 | 130 | <li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.delete_config_keys"><code class="docutils literal notranslate"><span class="pre">LanceDataset.delete_config_keys()</span></code></a></li> |
131 | | -<li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.diff_meta"><code class="docutils literal notranslate"><span class="pre">LanceDataset.diff_meta()</span></code></a></li> |
132 | 131 | <li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.drop"><code class="docutils literal notranslate"><span class="pre">LanceDataset.drop()</span></code></a></li> |
133 | 132 | <li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.drop_columns"><code class="docutils literal notranslate"><span class="pre">LanceDataset.drop_columns()</span></code></a></li> |
134 | 133 | <li class="toctree-l3"><a class="reference internal" href="#lance.LanceDataset.drop_index"><code class="docutils literal notranslate"><span class="pre">LanceDataset.drop_index()</span></code></a></li> |
|
443 | 442 | <li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.data_storage_version"><code class="docutils literal notranslate"><span class="pre">LanceDataset.data_storage_version</span></code></a></li> |
444 | 443 | <li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.delete"><code class="docutils literal notranslate"><span class="pre">LanceDataset.delete()</span></code></a></li> |
445 | 444 | <li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.delete_config_keys"><code class="docutils literal notranslate"><span class="pre">LanceDataset.delete_config_keys()</span></code></a></li> |
446 | | -<li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.diff_meta"><code class="docutils literal notranslate"><span class="pre">LanceDataset.diff_meta()</span></code></a></li> |
447 | 445 | <li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.drop"><code class="docutils literal notranslate"><span class="pre">LanceDataset.drop()</span></code></a></li> |
448 | 446 | <li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.drop_columns"><code class="docutils literal notranslate"><span class="pre">LanceDataset.drop_columns()</span></code></a></li> |
449 | 447 | <li class="toctree-l3"><a class="reference internal" href="#lance.dataset.LanceDataset.drop_index"><code class="docutils literal notranslate"><span class="pre">LanceDataset.drop_index()</span></code></a></li> |
|
1939 | 1937 | </dl> |
1940 | 1938 | </dd></dl> |
1941 | 1939 |
|
1942 | | -<dl class="py method"> |
1943 | | -<dt class="sig sig-object py" id="lance.LanceDataset.diff_meta"> |
1944 | | -<span class="sig-name descname"><span class="pre">diff_meta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compared_version</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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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 internal" href="#lance.dataset.Transaction" title="lance.dataset.Transaction"><span class="pre">Transaction</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#lance.LanceDataset.diff_meta" title="Link to this definition"></a></dt> |
1945 | | -<dd><p>Get the transaction list between current version and compared version |
1946 | | -as metadata differences.</p> |
1947 | | -<dl class="field-list simple"> |
1948 | | -<dt class="field-odd">Parameters<span class="colon">:</span></dt> |
1949 | | -<dd class="field-odd"><p><strong>compared_version</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The version to compare against, the compared_version must be greater than 0 |
1950 | | -and less than the current version. |
1951 | | -Note that the compared_version may not exist in the dataset due to |
1952 | | -clean-up action, in which case it would throw a <cite>VersionNotFound</cite> error.</p> |
1953 | | -</dd> |
1954 | | -<dt class="field-even">Returns<span class="colon">:</span></dt> |
1955 | | -<dd class="field-even"><p>List of transactions representing the differences</p> |
1956 | | -</dd> |
1957 | | -<dt class="field-odd">Return type<span class="colon">:</span></dt> |
1958 | | -<dd class="field-odd"><p>List[<a class="reference internal" href="#lance.Transaction" title="lance.Transaction">Transaction</a>]</p> |
1959 | | -</dd> |
1960 | | -</dl> |
1961 | | -</dd></dl> |
1962 | | - |
1963 | 1940 | <dl class="py method"> |
1964 | 1941 | <dt class="sig sig-object py" id="lance.LanceDataset.drop"> |
1965 | 1942 | <em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">drop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_uri</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 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/pathlib.html#pathlib.Path" title="(in Python v3.14)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_options</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/typing.html#typing.Dict" title="(in Python v3.14)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><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 class="p"><span class="pre">,</span></span><span class="w"> </span><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 class="p"><span class="pre">]</span></span><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>, <em class="sig-param"><span class="n"><span class="pre">ignore_not_found</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#bool" title="(in Python v3.14)"><span class="pre">bool</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">→</span> <span class="sig-return-typehint"><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><a class="headerlink" href="#lance.LanceDataset.drop" title="Link to this definition"></a></dt> |
|
6042 | 6019 | </dl> |
6043 | 6020 | </dd></dl> |
6044 | 6021 |
|
6045 | | -<dl class="py method"> |
6046 | | -<dt class="sig sig-object py" id="lance.dataset.LanceDataset.diff_meta"> |
6047 | | -<span class="sig-name descname"><span class="pre">diff_meta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">compared_version</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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</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 internal" href="#lance.dataset.Transaction" title="lance.dataset.Transaction"><span class="pre">Transaction</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#lance.dataset.LanceDataset.diff_meta" title="Link to this definition"></a></dt> |
6048 | | -<dd><p>Get the transaction list between current version and compared version |
6049 | | -as metadata differences.</p> |
6050 | | -<dl class="field-list simple"> |
6051 | | -<dt class="field-odd">Parameters<span class="colon">:</span></dt> |
6052 | | -<dd class="field-odd"><p><strong>compared_version</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – The version to compare against, the compared_version must be greater than 0 |
6053 | | -and less than the current version. |
6054 | | -Note that the compared_version may not exist in the dataset due to |
6055 | | -clean-up action, in which case it would throw a <cite>VersionNotFound</cite> error.</p> |
6056 | | -</dd> |
6057 | | -<dt class="field-even">Returns<span class="colon">:</span></dt> |
6058 | | -<dd class="field-even"><p>List of transactions representing the differences</p> |
6059 | | -</dd> |
6060 | | -<dt class="field-odd">Return type<span class="colon">:</span></dt> |
6061 | | -<dd class="field-odd"><p>List[<a class="reference internal" href="#lance.dataset.Transaction" title="lance.dataset.Transaction">Transaction</a>]</p> |
6062 | | -</dd> |
6063 | | -</dl> |
6064 | | -</dd></dl> |
6065 | | - |
6066 | 6022 | <dl class="py method"> |
6067 | 6023 | <dt class="sig sig-object py" id="lance.dataset.LanceDataset.drop"> |
6068 | 6024 | <em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">drop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_uri</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 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/pathlib.html#pathlib.Path" title="(in Python v3.14)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_options</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/typing.html#typing.Dict" title="(in Python v3.14)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><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 class="p"><span class="pre">,</span></span><span class="w"> </span><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 class="p"><span class="pre">]</span></span><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>, <em class="sig-param"><span class="n"><span class="pre">ignore_not_found</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#bool" title="(in Python v3.14)"><span class="pre">bool</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">→</span> <span class="sig-return-typehint"><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><a class="headerlink" href="#lance.dataset.LanceDataset.drop" title="Link to this definition"></a></dt> |
|
0 commit comments