mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-10 05:42:58 +00:00
db125013fc
* Sets `"useCodeBlocks": true` * Adds a post-processing script `nodejs/typedoc_post_process.js` that puts the parameter description on the same line as the parameter name, like it is in our Python docs. This makes the text hierarchy clearer in those sections and also makes the sections shorter.
107 lines
1.9 KiB
Markdown
107 lines
1.9 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / CreateTableOptions
|
|
|
|
# Interface: CreateTableOptions
|
|
|
|
## Properties
|
|
|
|
### dataStorageVersion?
|
|
|
|
```ts
|
|
optional dataStorageVersion: string;
|
|
```
|
|
|
|
The version of the data storage format to use.
|
|
|
|
The default is `stable`.
|
|
Set to "legacy" to use the old format.
|
|
|
|
***
|
|
|
|
### embeddingFunction?
|
|
|
|
```ts
|
|
optional embeddingFunction: EmbeddingFunctionConfig;
|
|
```
|
|
|
|
***
|
|
|
|
### enableV2ManifestPaths?
|
|
|
|
```ts
|
|
optional enableV2ManifestPaths: boolean;
|
|
```
|
|
|
|
Use the new V2 manifest paths. These paths provide more efficient
|
|
opening of datasets with many versions on object stores. WARNING:
|
|
turning this on will make the dataset unreadable for older versions
|
|
of LanceDB (prior to 0.10.0). To migrate an existing dataset, instead
|
|
use the LocalTable#migrateManifestPathsV2 method.
|
|
|
|
***
|
|
|
|
### existOk
|
|
|
|
```ts
|
|
existOk: boolean;
|
|
```
|
|
|
|
If this is true and the table already exists and the mode is "create"
|
|
then no error will be raised.
|
|
|
|
***
|
|
|
|
### mode
|
|
|
|
```ts
|
|
mode: "overwrite" | "create";
|
|
```
|
|
|
|
The mode to use when creating the table.
|
|
|
|
If this is set to "create" and the table already exists then either
|
|
an error will be thrown or, if existOk is true, then nothing will
|
|
happen. Any provided data will be ignored.
|
|
|
|
If this is set to "overwrite" then any existing table will be replaced.
|
|
|
|
***
|
|
|
|
### schema?
|
|
|
|
```ts
|
|
optional schema: SchemaLike;
|
|
```
|
|
|
|
***
|
|
|
|
### storageOptions?
|
|
|
|
```ts
|
|
optional storageOptions: Record<string, string>;
|
|
```
|
|
|
|
Configuration for object storage.
|
|
|
|
Options already set on the connection will be inherited by the table,
|
|
but can be overridden here.
|
|
|
|
The available options are described at https://lancedb.github.io/lancedb/guides/storage/
|
|
|
|
***
|
|
|
|
### useLegacyFormat?
|
|
|
|
```ts
|
|
optional useLegacyFormat: boolean;
|
|
```
|
|
|
|
If true then data files will be written with the legacy format
|
|
|
|
The default is false.
|
|
|
|
Deprecated. Use data storage version instead.
|