Extension Config

To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.

Note

If you created your service plugin extension with the CLI, required fields are automatically populated for you.

Configuration Params
namespacestring

The namespace of the external database. This can be used to access collections within the database, for example namespace/collectionId.


uriConfigSpiBaseUri

The URI where the service provider is deployed.


Was this helpful?
Yes
No

listCollections( )

Important: This is a handler function. Implement it only as part of the service plugin.


Retrieves a list of data collections and their details.

When collectionIds is empty, all existing collections are returned. If a specified collection does not exist, that collection can be ignored.

Method Declaration
Copy
Method Parameters
payloadListCollectionsEnvelope
Returns
Return Type:ListCollectionsResponse | Promise<ListCollectionsResponse>
Was this helpful?
Yes
No