API.md

API Reference

Table of Contents

• Classes
  • Database
  • DatabaseRef
• Interfaces
  • IDatabase
• Structs
  • AwsParameters
  • ConnectionOptions
  • DatabaseProps

Database (preflight class)

No description

Constructor

new(props: DatabaseProps): Database

Properties

Name	Type	Description
connection	ConnectionOptions	No description

Methods

Signature	Description
inflight connectionOptions(): ConnectionOptions	No description
inflight query(query: str): Array<Map>	No description

DatabaseRef (preflight class)

No description

Constructor

new(): DatabaseRef

Properties

No properties

Methods

Signature	Description
inflight query(query: str): Array<Map>	No description

IDatabase (interface)

No description

Properties

No properties

Methods

Signature	Description
inflight connectionOptions(): ConnectionOptions?	No description
inflight query(query: str): Array<Map>	No description

AwsParameters (struct)

No description

Properties

Name	Type	Description
postgresEngine	str?	No description

ConnectionOptions (struct)

No description

Properties

Name	Type	Description
database	str	No description
host	str	No description
password	str	No description
port	str	No description
ssl	bool	No description
user	str	No description

DatabaseProps (struct)

No description

Properties

Name	Type	Description
name	str	No description
pgVersion	num?	No description