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

updateCollection( )

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


Updates the structure of an existing data collection.

Some parameters, such as capabilities and pagingMode, are determined by the service provider. If the collection passed in the request contains these parameters, their values must be ignored. However, these fields must be included in the response collection with relevant values.

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