Files
lancedb/docs/src/js/classes/MakeArrowTableOptions.md
Will Jones db125013fc docs: better formatting for Node API docs (#1892)
* 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.
2024-12-09 17:04:09 -08:00

74 lines
1.2 KiB
Markdown

[**@lancedb/lancedb**](../README.md) • **Docs**
***
[@lancedb/lancedb](../globals.md) / MakeArrowTableOptions
# Class: MakeArrowTableOptions
Options to control the makeArrowTable call.
## Constructors
### new MakeArrowTableOptions()
```ts
new MakeArrowTableOptions(values?): MakeArrowTableOptions
```
#### Parameters
* **values?**: `Partial`<[`MakeArrowTableOptions`](MakeArrowTableOptions.md)>
#### Returns
[`MakeArrowTableOptions`](MakeArrowTableOptions.md)
## Properties
### dictionaryEncodeStrings
```ts
dictionaryEncodeStrings: boolean = false;
```
If true then string columns will be encoded with dictionary encoding
Set this to true if your string columns tend to repeat the same values
often. For more precise control use the `schema` property to specify the
data type for individual columns.
If `schema` is provided then this property is ignored.
***
### embeddingFunction?
```ts
optional embeddingFunction: EmbeddingFunctionConfig;
```
***
### embeddings?
```ts
optional embeddings: EmbeddingFunction<unknown, FunctionOptions>;
```
***
### schema?
```ts
optional schema: SchemaLike;
```
***
### vectorColumns
```ts
vectorColumns: Record<string, VectorColumnOptions>;
```