index.md

dbcp / Exports / index

Module: index

Table of contents

Interfaces

• DatabaseCopyInput
• DatabaseCopyInputFile
• DatabaseCopyOptions
• DatabaseCopyOutput

Type aliases

• DatabaseCopyFormats

Functions

• assignDatabaseCopyInputProperties
• assignDatabaseCopyOutputProperties
• databaseInspectSchema
• dbcp
• dumpToFile
• getExternalSortFunction
• getInputConnection
• getInputConnectionString
• getInputFormat
• getInputFormats
• getOrderByFunction
• getOutputConnection
• getOutputConnectionString
• getOutputFormat
• getShardFunction
• guessFormatFromInput
• openInputs
• openOutputs

Type aliases

DatabaseCopyFormats

Ƭ DatabaseCopyFormats: Record<string, DatabaseCopyFormat | DatabaseCopyTransformFactory | null>

Defined in: index.ts:148

Functions

assignDatabaseCopyInputProperties

▸ assignDatabaseCopyInputProperties(target: DatabaseCopyInput, source?: DatabaseCopyInput): object

Parameters

Name	Type
target	DatabaseCopyInput
source?	DatabaseCopyInput

Returns: object

Name	Type
inputConnection	undefined | Record<string, any>
inputElasticSearch	undefined | Client
inputFiles	undefined | DatabaseCopyInputFile[] | Record<string, DatabaseCopyInputFile>
inputFormat	undefined | DatabaseCopyFormat | DatabaseCopyTransformFactory
inputHost	undefined | string
inputKnex	undefined | Knex<any, unknown[]>
inputLeveldb	undefined | LevelDB<any, any> | LevelUp<AbstractLevelDOWN<any, any>, AbstractIterator<any, any>>
inputMongodb	undefined | MongoClient
inputName	undefined | string
inputPassword	undefined | string
inputPort	undefined | number
inputShardBy	undefined | string
inputShardFunction	undefined | DatabaseCopyShardFunction
inputShardIndex	undefined | number
inputShards	undefined | number
inputStream	undefined | ReadableStreamTree
inputTable	undefined | string
inputType	undefined | DatabaseCopyInputType
inputUser	undefined | string

Defined in: index.ts:849

---

assignDatabaseCopyOutputProperties

▸ assignDatabaseCopyOutputProperties(target: DatabaseCopyOutput, source?: DatabaseCopyOutput): object

Parameters

Name	Type
target	DatabaseCopyOutput
source?	DatabaseCopyOutput

Returns: object

Name	Type
outputConnection	undefined | Record<string, any>
outputElasticSearch	undefined | Client
outputFile	undefined | string
outputFormat	undefined | DatabaseCopyFormat | DatabaseCopyTransformFactory
outputHost	undefined | string
outputKnex	undefined | Knex<any, unknown[]>
outputLeveldb	undefined | LevelDB<any, any> | LevelUp<AbstractLevelDOWN<any, any>, AbstractIterator<any, any>>
outputMongodb	undefined | MongoClient
outputName	undefined | string
outputPassword	undefined | string
outputPort	undefined | number
outputShardFunction?	DatabaseCopyShardFunctionOverride | DatabaseCopyShardFunction
outputShards	undefined | number
outputStream	undefined | WritableStreamTree[]
outputTable	undefined | string
outputType	undefined | DatabaseCopyOutputType
outputUser	undefined | string

Defined in: index.ts:877

---

databaseInspectSchema

▸ databaseInspectSchema(args: DatabaseCopyOptions): Promise<Column[]>

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: Promise<Column[]>

Defined in: index.ts:830

---

dbcp

▸ dbcp(args: DatabaseCopyOptions): Promise<void>

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: Promise<void>

Defined in: index.ts:378

---

dumpToFile

▸ dumpToFile(input: ReadableStreamTree | undefined, outputs: WritableStreamTree[], options: { columnType?: Record<string, string> ; copySchema?: DatabaseCopySchema ; externalSortFunction?: (x: any) => any[] ; format?: DatabaseCopyFormat | DatabaseCopyTransformFactory ; formattingKnex?: Knex ; inputTable?: string ; outputShards?: number ; outputType?: string ; schema?: Column[] ; shardFunction?: (x: Record<string, any>, modulus: number) => number ; tempDirectories?: string[] ; transformObject?: (x: unknown) => unknown ; transformObjectStream?: DatabaseCopyTransformFactory }): Promise<void>

Parameters

Name	Type
input	ReadableStreamTree | undefined
outputs	WritableStreamTree[]
options	object
options.columnType?	Record<string, string>
options.copySchema?	DatabaseCopySchema
options.externalSortFunction?	(x: any) => any[]
options.format?	DatabaseCopyFormat | DatabaseCopyTransformFactory
options.formattingKnex?	Knex
options.inputTable?	string
options.outputShards?	number
options.outputType?	string
options.schema?	Column[]
options.shardFunction?	(x: Record<string, any>, modulus: number) => number
options.tempDirectories?	string[]
options.transformObject?	(x: unknown) => unknown
options.transformObjectStream?	DatabaseCopyTransformFactory

Returns: Promise<void>

Defined in: index.ts:618

---

getExternalSortFunction

▸ getExternalSortFunction(args: DatabaseCopyOptions): (x: any) => any[]

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: (x: any) => any[]

Defined in: index.ts:253

---

getInputConnection

▸ getInputConnection(args: DatabaseCopyOptions): { database: undefined ; filename: undefined | string ; timezone: string = 'UTC'; user: undefined } | { charset: undefined | string ; database: undefined | string ; filename: undefined ; host: undefined | string ; options: undefined | { trustServerCertificate: boolean = true } ; password: undefined | string ; port: undefined | number ; timezone: string = 'UTC'; user: undefined | string }

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: { database: undefined ; filename: undefined | string ; timezone: string = 'UTC'; user: undefined } | { charset: undefined | string ; database: undefined | string ; filename: undefined ; host: undefined | string ; options: undefined | { trustServerCertificate: boolean = true } ; password: undefined | string ; port: undefined | number ; timezone: string = 'UTC'; user: undefined | string }

Defined in: index.ts:157

---

getInputConnectionString

▸ getInputConnectionString(args: { inputHost?: string ; inputPassword?: string ; inputPort?: string | number ; inputUser?: string }): string

Parameters

Name	Type
args	object
args.inputHost?	string
args.inputPassword?	string
args.inputPort?	string | number
args.inputUser?	string

Returns: string

Defined in: index.ts:203

---

getInputFormat

▸ getInputFormat(args: DatabaseCopyOptions, inputFormats: DatabaseCopyFormats): undefined | DatabaseCopyFormat | DatabaseCopyTransformFactory

Parameters

Name	Type
args	DatabaseCopyOptions
inputFormats	DatabaseCopyFormats

Returns: undefined | DatabaseCopyFormat | DatabaseCopyTransformFactory

Defined in: index.ts:282

---

getInputFormats

▸ getInputFormats(args: DatabaseCopyOptions): DatabaseCopyFormats

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: DatabaseCopyFormats

Defined in: index.ts:257

---

getOrderByFunction

▸ getOrderByFunction(args: DatabaseCopyOptions): function

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: (a: Record<string, any>, b: Record<string, any>) => 1 | 0 | -1

Defined in: index.ts:241

---

getOutputConnection

▸ getOutputConnection(args: DatabaseCopyOptions): { filename: undefined | string ; timezone: string = 'UTC' } | { charset: undefined | string ; database: undefined | string ; filename: undefined ; host: undefined | string ; options: undefined | { trustServerCertificate: boolean = true } ; password: undefined | string ; port: undefined | number ; timezone: string = 'UTC'; user: undefined | string }

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: { filename: undefined | string ; timezone: string = 'UTC' } | { charset: undefined | string ; database: undefined | string ; filename: undefined ; host: undefined | string ; options: undefined | { trustServerCertificate: boolean = true } ; password: undefined | string ; port: undefined | number ; timezone: string = 'UTC'; user: undefined | string }

Defined in: index.ts:183

---

getOutputConnectionString

▸ getOutputConnectionString(args: { outputHost?: string ; outputPassword?: string ; outputPort?: string | number ; outputUser?: string }): string

Parameters

Name	Type
args	object
args.outputHost?	string
args.outputPassword?	string
args.outputPort?	string | number
args.outputUser?	string

Returns: string

Defined in: index.ts:212

---

getOutputFormat

▸ getOutputFormat(args: DatabaseCopyOptions, inputFormat?: DatabaseCopyFormat | DatabaseCopyTransformFactory): DatabaseCopyFormat | DatabaseCopyTransformFactory

Parameters

Name	Type
args	DatabaseCopyOptions
inputFormat?	DatabaseCopyFormat | DatabaseCopyTransformFactory

Returns: DatabaseCopyFormat | DatabaseCopyTransformFactory

Defined in: index.ts:289

---

getShardFunction

▸ getShardFunction(args: DatabaseCopyOptions): DatabaseCopyShardFunctionOverride

Parameters

Name	Type
args	DatabaseCopyOptions

Returns: DatabaseCopyShardFunctionOverride

Defined in: index.ts:221

---

guessFormatFromInput

▸ guessFormatFromInput(input: DatabaseCopyInputFile): null | csv | json | jsonl | object | parquet | tfrecord | sql

Parameters

Name	Type
input	DatabaseCopyInputFile

Returns: null | csv | json | jsonl | object | parquet | tfrecord | sql

Defined in: index.ts:153

---

openInputs

▸ openInputs(args: DatabaseCopyOptions, inputFiles: [string, DatabaseCopyInputFile][], inputFormats: DatabaseCopyFormats, inputFormat?: DatabaseCopyFormat | DatabaseCopyTransformFactory, outputFormat?: DatabaseCopyFormat | DatabaseCopyTransformFactory): Promise<ReadableStreamTree[] | Record<string, ReadableStreamTree | ReadableStreamTree[]>>

Parameters

Name	Type
args	DatabaseCopyOptions
inputFiles	[string, DatabaseCopyInputFile][]
inputFormats	DatabaseCopyFormats
inputFormat?	DatabaseCopyFormat | DatabaseCopyTransformFactory
outputFormat?	DatabaseCopyFormat | DatabaseCopyTransformFactory

Returns: Promise<ReadableStreamTree[] | Record<string, ReadableStreamTree | ReadableStreamTree[]>>

Defined in: index.ts:301

---

openOutputs

▸ openOutputs(args: DatabaseCopyOptions, format?: DatabaseCopyFormat | DatabaseCopyTransformFactory): Promise<WritableStreamTree[]>

Parameters

Name	Type
args	DatabaseCopyOptions
format?	DatabaseCopyFormat | DatabaseCopyTransformFactory

Returns: Promise<WritableStreamTree[]>

Defined in: index.ts:356