Backstage
Docs
Github
Preparing search index...
@backstage/plugin-search-backend-module-pg
index
DatabaseStore
Interface DatabaseStore
interface
DatabaseStore
{
completeInsert
(
tx
:
Transaction
,
type
:
string
,
truncate
?:
boolean
,
)
:
Promise
<
void
>
;
getTransaction
()
:
Promise
<
Transaction
<
any
,
any
[]
>
>
;
insertDocuments
(
tx
:
Transaction
,
type
:
string
,
documents
:
IndexableDocument
[]
,
)
:
Promise
<
void
>
;
prepareInsert
(
tx
:
Transaction
)
:
Promise
<
void
>
;
query
(
tx
:
Transaction
,
pgQuery
:
PgSearchQuery
,
)
:
Promise
<
DocumentResultRow
[]
>
;
transaction
<
T
>
(
fn
:
(
tx
:
Transaction
)
=>
Promise
<
T
>
)
:
Promise
<
T
>
;
}
Implemented by
DatabaseDocumentStore
Index
Methods
complete
Insert
get
Transaction
insert
Documents
prepare
Insert
query
transaction
Methods
complete
Insert
completeInsert
(
tx
:
Transaction
,
type
:
string
,
truncate
?:
boolean
)
:
Promise
<
void
>
Parameters
tx
:
Transaction
type
:
string
Optional
truncate
:
boolean
Returns
Promise
<
void
>
get
Transaction
getTransaction
()
:
Promise
<
Transaction
<
any
,
any
[]
>
>
Returns
Promise
<
Transaction
<
any
,
any
[]
>
>
insert
Documents
insertDocuments
(
tx
:
Transaction
,
type
:
string
,
documents
:
IndexableDocument
[]
,
)
:
Promise
<
void
>
Parameters
tx
:
Transaction
type
:
string
documents
:
IndexableDocument
[]
Returns
Promise
<
void
>
prepare
Insert
prepareInsert
(
tx
:
Transaction
)
:
Promise
<
void
>
Parameters
tx
:
Transaction
Returns
Promise
<
void
>
query
query
(
tx
:
Transaction
,
pgQuery
:
PgSearchQuery
)
:
Promise
<
DocumentResultRow
[]
>
Parameters
tx
:
Transaction
pgQuery
:
PgSearchQuery
Returns
Promise
<
DocumentResultRow
[]
>
transaction
transaction
<
T
>
(
fn
:
(
tx
:
Transaction
)
=>
Promise
<
T
>
)
:
Promise
<
T
>
Type Parameters
T
Parameters
fn
:
(
tx
:
Transaction
)
=>
Promise
<
T
>
Returns
Promise
<
T
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
complete
Insert
get
Transaction
insert
Documents
prepare
Insert
query
transaction
Docs
Github
Backstage
Loading...