Class LocalDatabase

The local database is responsible for syncing the remote rekordbox databases of media slots on a device into in-memory sqlite databases.

This service will attempt to ensure the in-memory databases for each media device that is connected to a CDJ is locally kept in sync. Fetching the database for any media slot of it's not already cached.

Hierarchy

LocalDatabase

Index

Constructors

constructor

new LocalDatabase(hostDevice: Device, deviceManager: DeviceManager, statusEmitter: StatusEmitter): LocalDatabase
Parameters
- hostDevice: Device
- deviceManager: DeviceManager
- statusEmitter: StatusEmitter
Returns LocalDatabase
- Defined in src/localdb/index.ts:140

Properties

`Private` #dbs

#dbs: DatabaseItem[] = []

The current available databases

`Private` #deviceManager

#deviceManager: DeviceManager

`Private` #emitter

#emitter: Emitter = ...

The EventEmitter that will report database events

`Private` #hostDevice

#hostDevice: Device

`Private` #slotLocks

#slotLocks: Map<string, Mutex> = ...

Locks for each device slot: ${device.id}-${slot}. Used when making track requets.

`Private` #statusEmitter

#statusEmitter: StatusEmitter

off

off: ((eventName: string | symbol, listener: ((...args: any[]) => void)) => EventEmitter) = ...

Type declaration

- (eventName: string | symbol, listener: ((...args: any[]) => void)): EventEmitter
- Alias for emitter.removeListener().
  
  Since
  v10.0.0
  Parameters
  - eventName: string | symbol
  - listener: ((...args: any[]) => void)
    - (...args: any[]): void
      
      Parameters
      
      Rest ...args: any[]
      
      Returns void
  Returns EventEmitter

on

on: {
<P, T>(this: T, event: P, listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)): T;
(event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void;
} = ...

Type declaration

- <P, T>(this: T, event: P, listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)): T
- Type Parameters
  - P extends keyof DatabaseEvents
  - T
  Parameters
  - this: T
  - event: P
  - listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)
    - (...args: ListenerType<DatabaseEvents[P]>): void
      
      Parameters
      
      Rest ...args: ListenerType<DatabaseEvents[P]>
      
      Returns void
  Returns T
- (event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void
- Parameters
  - event: typeof assignmentCompatibilityHack
  - listener: ((...args: any[]) => any)
    - (...args: any[]): any
      
      Parameters
      
      Rest ...args: any[]
      
      Returns any
  Returns void

once

once: {
<P, T>(this: T, event: P, listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)): T;
(event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void;
} = ...

Type declaration

- <P, T>(this: T, event: P, listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)): T
- Type Parameters
  - P extends keyof DatabaseEvents
  - T
  Parameters
  - this: T
  - event: P
  - listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)
    - (...args: ListenerType<DatabaseEvents[P]>): void
      
      Parameters
      
      Rest ...args: ListenerType<DatabaseEvents[P]>
      
      Returns void
  Returns T
- (event: typeof assignmentCompatibilityHack, listener: ((...args: any[]) => any)): void
- Parameters
  - event: typeof assignmentCompatibilityHack
  - listener: ((...args: any[]) => any)
    - (...args: any[]): any
      
      Parameters
      
      Rest ...args: any[]
      
      Returns any
  Returns void

Methods

`Private` #handleDeviceRemoved

#handleDeviceRemoved(device: Device): void
Closes the database connection and removes the database entry when a device is removed.
Parameters
- device: Device
Returns void
- Defined in src/localdb/index.ts:168

`Private` #hydrateDatabase

#hydrateDatabase(device: Device, slot: DatabaseSlot, media: MediaSlotInfo): Promise<{
    id: string;
    media: MediaSlotInfo;
    orm: MetadataORM;
}>
Downloads and hydrates a new in-memory sqlite database
Parameters
- device: Device
- slot: DatabaseSlot
- media: MediaSlotInfo
Returns Promise<{
    id: string;
    media: MediaSlotInfo;
    orm: MetadataORM;
}>
- Defined in src/localdb/index.ts:176

disconnectForDevice

disconnectForDevice(device: Device): void
Disconnects the local database connection for the specified device
Parameters
- device: Device
Returns void
- Defined in src/localdb/index.ts:160

get

get(deviceId: number, slot: DatabaseSlot): Promise<null | MetadataORM>
Gets the sqlite ORM service for to a database hydrated with the media metadata for the provided device slot.

If the database has not already been hydrated this will first hydrate the database, which may take some time depending on the size of the database.

Returns
null if no rekordbox media present
Parameters
- deviceId: number
- slot: DatabaseSlot
Returns Promise<null | MetadataORM>
- Defined in src/localdb/index.ts:241

preload

preload(): Promise<void>
Preload the databases for all connected devices.

Returns Promise<void>
- Defined in src/localdb/index.ts:281

Class LocalDatabase

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

hostDevice: Device

deviceManager: DeviceManager

statusEmitter: StatusEmitter

Returns LocalDatabase

Properties

Private #dbs

Private #deviceManager

Private #emitter

Private #hostDevice

Private #slotLocks

Private #statusEmitter

off

Type declaration

Since

Parameters

eventName: string | symbol

listener: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns EventEmitter

on

Type declaration

Type Parameters

P extends keyof DatabaseEvents

T

Parameters

this: T

event: P

listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)

Parameters

Rest ...args: ListenerType<DatabaseEvents[P]>

Returns void

Returns T

Parameters

event: typeof assignmentCompatibilityHack

listener: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

once

Type declaration

Type Parameters

P extends keyof DatabaseEvents

T

Parameters

this: T

event: P

listener: ((...args: ListenerType<DatabaseEvents[P]>) => void)

Parameters

Rest ...args: ListenerType<DatabaseEvents[P]>

Returns void

Returns T

Parameters

event: typeof assignmentCompatibilityHack

listener: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

Methods

Private #handleDeviceRemoved

Parameters

device: Device

Returns void

Private #hydrateDatabase

Parameters

device: Device

slot: DatabaseSlot

media: MediaSlotInfo

`Private` #dbs

`Private` #deviceManager

`Private` #emitter

`Private` #hostDevice

`Private` #slotLocks

`Private` #statusEmitter

`Rest` ...args: any[]

`Rest` ...args: ListenerType<DatabaseEvents[P]>

`Rest` ...args: any[]

`Rest` ...args: ListenerType<DatabaseEvents[P]>

`Rest` ...args: any[]

`Private` #handleDeviceRemoved

`Private` #hydrateDatabase

Returns Promise<{
id: string;
media: MediaSlotInfo;
orm: MetadataORM;
}>