Search
Preparing search index...
The search index is not available
@truffle/db
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@truffle/db
Meta
Pouch
Adapters
Couch
Databases
Class Databases<C>
Type parameters
C
:
Collections
Hierarchy
Databases
<
C
>
Databases
Index
Constructors
constructor
Properties
_create
Database
Methods
create
Database
delete
every
retrieve
save
search
setup
Constructors
constructor
new
Databases<C>
(
options
:
DatabasesOptions
<
C
>
)
:
Databases
<
C
>
Type parameters
C
:
Collections
Parameters
options:
DatabasesOptions
<
C
>
Returns
Databases
<
C
>
Properties
Private
_create
Database
_create
Database
:
(
resource
:
any
)
=>
Database
<
{}
>
Type declaration
(
resource
:
any
)
:
Database
<
{}
>
Parameters
resource:
any
Returns
Database
<
{}
>
Methods
create
Database
create
Database
(
resource
:
any
)
:
Database
<
{}
>
Parameters
resource:
any
Returns
Database
<
{}
>
delete
delete<N, T>
(
collectionName
:
N
, references
:
(
undefined
|
Pick
<
Record
<
T
>
,
"_id"
>
)
[]
)
:
Promise
<
void
>
Type parameters
N
:
string
T
Parameters
collectionName:
N
references:
(
undefined
|
Pick
<
Record
<
T
>
,
"_id"
>
)
[]
Returns
Promise
<
void
>
every
every<N, T>
(
collectionName
:
N
)
:
Promise
<
SavedRecord
<
T
>
[]
>
Type parameters
N
:
string
T
Parameters
collectionName:
N
Returns
Promise
<
SavedRecord
<
T
>
[]
>
retrieve
retrieve<N, T>
(
collectionName
:
N
, records
:
(
undefined
|
Pick
<
Record
<
T
>
,
"_id"
>
)
[]
)
:
Promise
<
(
undefined
|
SavedRecord
<
T
>
)
[]
>
Type parameters
N
:
string
T
Parameters
collectionName:
N
records:
(
undefined
|
Pick
<
Record
<
T
>
,
"_id"
>
)
[]
Returns
Promise
<
(
undefined
|
SavedRecord
<
T
>
)
[]
>
save
save<N, T>
(
collectionName
:
N
, records
:
(
undefined
|
Record
<
T
>
)
[]
, options
?:
{
overwrite
?:
undefined
|
boolean
}
)
:
Promise
<
(
undefined
|
SavedRecord
<
T
>
)
[]
>
Type parameters
N
:
string
T
Parameters
collectionName:
N
records:
(
undefined
|
Record
<
T
>
)
[]
options:
{
overwrite
?:
undefined
|
boolean
}
= ...
Optional
overwrite
?:
undefined
|
boolean
Returns
Promise
<
(
undefined
|
SavedRecord
<
T
>
)
[]
>
search
search<N, T>
(
collectionName
:
N
, options
:
FindRequest
<
{}
>
)
:
Promise
<
SavedRecord
<
T
>
[]
>
Type parameters
N
:
string
T
Parameters
collectionName:
N
options:
FindRequest
<
{}
>
Returns
Promise
<
SavedRecord
<
T
>
[]
>
setup
setup
(
settings
:
DatabasesSettings
)
:
void
Parameters
settings:
DatabasesSettings
Returns
void
Exports
Data
Model
Graph
Meta
Batch
Graph
Id
Pouch
Adapters
Base
Couch
Fs
Generic
Memory
Sqlite
Process
Network
Pouch
Process
Project
Resources
Databases
constructor
_create
Database
create
Database
delete
every
retrieve
save
search
setup
Databases
Settings
get
Default
Settings
Generated using
TypeDoc