index.databasecopyoptions.md

dbcp / Exports / index / DatabaseCopyOptions

Interface: DatabaseCopyOptions

index.DatabaseCopyOptions

Hierarchy

• DatabaseCopyInput

• DatabaseCopyOutput

  ↳ DatabaseCopyOptions

Table of contents

Properties

• batchSize
• columnType
• compoundInsert
• contentType
• copySchema
• engineOptions
• externalSortBy
• extra
• extraOutput
• fileSystem
• group
• groupLabels
• inputConnection
• inputElasticSearch
• inputFiles
• inputFormat
• inputHost
• inputKnex
• inputLeveldb
• inputMongodb
• inputName
• inputPassword
• inputPort
• inputShardBy
• inputShardFunction
• inputShardIndex
• inputShards
• inputStream
• inputTable
• inputType
• inputUser
• limit
• logger
• orderBy
• outputConnection
• outputElasticSearch
• outputFile
• outputFormat
• outputHost
• outputKnex
• outputLeveldb
• outputMongodb
• outputName
• outputPassword
• outputPort
• outputShardFunction
• outputShards
• outputStream
• outputTable
• outputType
• outputUser
• probeBytes
• query
• schema
• schemaFile
• shardBy
• tempDirectories
• transformBytes
• transformBytesStream
• transformObject
• transformObjectStream
• where

Properties

batchSize

• Optional batchSize: number

Defined in: index.ts:120

---

columnType

• Optional columnType: Record<string, string>

Defined in: index.ts:121

---

compoundInsert

• Optional compoundInsert: boolean

Defined in: index.ts:122

---

contentType

• Optional contentType: string

Defined in: index.ts:123

---

copySchema

• Optional copySchema: DatabaseCopySchema

Defined in: index.ts:124

---

engineOptions

• Optional engineOptions: any

Defined in: index.ts:125

---

externalSortBy

• Optional externalSortBy: string[]

Defined in: index.ts:126

---

extra

• Optional extra: Record<string, any>

Defined in: index.ts:127

---

extraOutput

• Optional extraOutput: boolean

Defined in: index.ts:128

---

fileSystem

• Optional fileSystem: FileSystem

Defined in: index.ts:129

---

group

• Optional group: boolean

Defined in: index.ts:130

---

groupLabels

• Optional groupLabels: boolean

Defined in: index.ts:131

---

inputConnection

• Optional inputConnection: Record<string, any>

Inherited from: DatabaseCopyInput.inputConnection

Defined in: index.ts:78

---

inputElasticSearch

• Optional inputElasticSearch: Client

Inherited from: DatabaseCopyInput.inputElasticSearch

Defined in: index.ts:79

---

inputFiles

• Optional inputFiles: DatabaseCopyInputFile[] | Record<string, DatabaseCopyInputFile>

Inherited from: DatabaseCopyInput.inputFiles

Defined in: index.ts:81

---

inputFormat

• Optional inputFormat: DatabaseCopyFormat | DatabaseCopyTransformFactory

Inherited from: DatabaseCopyInput.inputFormat

Defined in: index.ts:80

---

inputHost

• Optional inputHost: string

Inherited from: DatabaseCopyInput.inputHost

Defined in: index.ts:82

---

inputKnex

• Optional inputKnex: Knex<any, unknown[]>

Inherited from: DatabaseCopyInput.inputKnex

Defined in: index.ts:86

---

inputLeveldb

• Optional inputLeveldb: LevelDB<any, any> | LevelUp<AbstractLevelDOWN<any, any>, AbstractIterator<any, any>>

Inherited from: DatabaseCopyInput.inputLeveldb

Defined in: index.ts:83

---

inputMongodb

• Optional inputMongodb: MongoClient

Inherited from: DatabaseCopyInput.inputMongodb

Defined in: index.ts:84

---

inputName

• Optional inputName: string

Inherited from: DatabaseCopyInput.inputName

Defined in: index.ts:85

---

inputPassword

• Optional inputPassword: string

Inherited from: DatabaseCopyInput.inputPassword

Defined in: index.ts:87

---

inputPort

• Optional inputPort: number

Inherited from: DatabaseCopyInput.inputPort

Defined in: index.ts:95

---

inputShardBy

• Optional inputShardBy: string

Inherited from: DatabaseCopyInput.inputShardBy

Defined in: index.ts:88

---

inputShardFunction

• Optional inputShardFunction: DatabaseCopyShardFunction

Inherited from: DatabaseCopyInput.inputShardFunction

Defined in: index.ts:89

---

inputShardIndex

• Optional inputShardIndex: number

Inherited from: DatabaseCopyInput.inputShardIndex

Defined in: index.ts:90

---

inputShards

• Optional inputShards: number

Inherited from: DatabaseCopyInput.inputShards

Defined in: index.ts:91

---

inputStream

• Optional inputStream: ReadableStreamTree

Inherited from: DatabaseCopyInput.inputStream

Defined in: index.ts:92

---

inputTable

• Optional inputTable: string

Inherited from: DatabaseCopyInput.inputTable

Defined in: index.ts:93

---

inputType

• Optional inputType: DatabaseCopyInputType

Inherited from: DatabaseCopyInput.inputType

Defined in: index.ts:94

---

inputUser

• Optional inputUser: string

Inherited from: DatabaseCopyInput.inputUser

Defined in: index.ts:96

---

limit

• Optional limit: number

Defined in: index.ts:132

---

logger

• Optional logger: Logger

Defined in: index.ts:133

---

orderBy

• Optional orderBy: string[]

Defined in: index.ts:134

---

outputConnection

• Optional outputConnection: Record<string, any>

Inherited from: DatabaseCopyOutput.outputConnection

Defined in: index.ts:100

---

outputElasticSearch

• Optional outputElasticSearch: Client

Inherited from: DatabaseCopyOutput.outputElasticSearch

Defined in: index.ts:101

---

outputFile

• Optional outputFile: string

Inherited from: DatabaseCopyOutput.outputFile

Defined in: index.ts:103

---

outputFormat

• Optional outputFormat: DatabaseCopyFormat | DatabaseCopyTransformFactory

Inherited from: DatabaseCopyOutput.outputFormat

Defined in: index.ts:102

---

outputHost

• Optional outputHost: string

Inherited from: DatabaseCopyOutput.outputHost

Defined in: index.ts:104

---

outputKnex

• Optional outputKnex: Knex<any, unknown[]>

Inherited from: DatabaseCopyOutput.outputKnex

Defined in: index.ts:105

---

outputLeveldb

• Optional outputLeveldb: LevelDB<any, any> | LevelUp<AbstractLevelDOWN<any, any>, AbstractIterator<any, any>>

Inherited from: DatabaseCopyOutput.outputLeveldb

Defined in: index.ts:106

---

outputMongodb

• Optional outputMongodb: MongoClient

Inherited from: DatabaseCopyOutput.outputMongodb

Defined in: index.ts:107

---

outputName

• Optional outputName: string

Inherited from: DatabaseCopyOutput.outputName

Defined in: index.ts:108

---

outputPassword

• Optional outputPassword: string

Inherited from: DatabaseCopyOutput.outputPassword

Defined in: index.ts:109

---

outputPort

• Optional outputPort: number

Inherited from: DatabaseCopyOutput.outputPort

Defined in: index.ts:115

---

outputShardFunction

• Optional outputShardFunction: DatabaseCopyShardFunctionOverride | DatabaseCopyShardFunction

Inherited from: DatabaseCopyOutput.outputShardFunction

Defined in: index.ts:110

---

outputShards

• Optional outputShards: number

Inherited from: DatabaseCopyOutput.outputShards

Defined in: index.ts:111

---

outputStream

• Optional outputStream: WritableStreamTree[]

Inherited from: DatabaseCopyOutput.outputStream

Defined in: index.ts:112

---

outputTable

• Optional outputTable: string

Inherited from: DatabaseCopyOutput.outputTable

Defined in: index.ts:113

---

outputType

• Optional outputType: DatabaseCopyOutputType

Inherited from: DatabaseCopyOutput.outputType

Defined in: index.ts:114

---

outputUser

• Optional outputUser: string

Inherited from: DatabaseCopyOutput.outputUser

Defined in: index.ts:116

---

probeBytes

• Optional probeBytes: number

Defined in: index.ts:135

---

query

• Optional query: string

Defined in: index.ts:136

---

schema

• Optional schema: Column[]

Defined in: index.ts:138

---

schemaFile

• Optional schemaFile: string

Defined in: index.ts:139

---

shardBy

• Optional shardBy: string

Defined in: index.ts:137

---

tempDirectories

• Optional tempDirectories: string[]

Defined in: index.ts:140

---

transformBytes

• Optional transformBytes: (x: string) => string

Type declaration

▸ (x: string): string

Parameters

Name	Type
x	string

Returns: string

Defined in: index.ts:143

---

transformBytesStream

• Optional transformBytesStream: DatabaseCopyTransformFactory

Defined in: index.ts:144

---

transformObject

• Optional transformObject: (x: unknown) => unknown

Type declaration

▸ (x: unknown): unknown

Parameters

Name	Type
x	unknown

Returns: unknown

Defined in: index.ts:141

---

transformObjectStream

• Optional transformObjectStream: DatabaseCopyTransformFactory

Defined in: index.ts:142

---

where

• Optional where: (string | any[])[]

Defined in: index.ts:145