mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-08 04:42:57 +00:00
docs: add a reference to @lancedb/lance in the docs (#1166)
We aren't yet ready to switch over the examples since almost all JS examples rely on embeddings and we haven't yet ported those over. However, this makes it possible for those that are interested to start using `@lancedb/lancedb`
This commit is contained in:
41
docs/src/js/interfaces/CreateTableOptions.md
Normal file
41
docs/src/js/interfaces/CreateTableOptions.md
Normal file
@@ -0,0 +1,41 @@
|
||||
[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / CreateTableOptions
|
||||
|
||||
# Interface: CreateTableOptions
|
||||
|
||||
## Table of contents
|
||||
|
||||
### Properties
|
||||
|
||||
- [existOk](CreateTableOptions.md#existok)
|
||||
- [mode](CreateTableOptions.md#mode)
|
||||
|
||||
## Properties
|
||||
|
||||
### existOk
|
||||
|
||||
• **existOk**: `boolean`
|
||||
|
||||
If this is true and the table already exists and the mode is "create"
|
||||
then no error will be raised.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[connection.ts:35](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/connection.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### mode
|
||||
|
||||
• **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.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[connection.ts:30](https://github.com/lancedb/lancedb/blob/9d178c7/nodejs/lancedb/connection.ts#L30)
|
||||
Reference in New Issue
Block a user