Database tables

Steps to configure the list of database tables under each available database.

Before you begin

You must have administrator and API Assistant user permissions to view the API Assistant tab and access the API Assistant source page. For more details about roles and permission, see API Assistant user roles

Add database table

To add a database table source, you need to provide the necessary connection information for the source database, including a name, location, and credentials. Once you provide the connection information, the system will connect to the database allowing you to select which database tables should be added as sources to make available for use in your APIs.

To add a database table source, complete the following steps:
  1. On the API Manager, navigate to Resources > API Assistant. The API Assistant source page opens.
  2. Under Database tables, click Add.
    Note: For tech preview, only the PostgreSQL type database is supported.
  3. On the Database connection page, enter necessary details in the fields.
  4. In the Add database window, select checkbox against the tables you want to add and then click Add.
  5. Click Next to save the changes and add the table.

Edit database

To modify the database table list, complete the following steps:
  1. On the API Manager, navigate to Resources > API Assistant. The API Assistant source page opens.
  2. Under Database tables, click the Options icon next to the Last updated column, and click Edit table list.
  3. On the Edit tables window, you can select or clear checkboxes against the respective tables to add or remove the tables.
  4. Click Save.

Refresh database table

The Refresh option updates the table to reflect any changes made in the backend. For example, if you have added or deleted any fields in the database table, refresh the table to display the most recent updates. To refresh the database tables, click the Options icon and click Refresh.

Edit database connection

You can use the Edit connection option to edit the fields in the database connection window. To modify the database table source fields, complete the following steps:
  1. From the API Manager, navigate to Resources > API Assistant. The API Assistant source page opens.
  2. Under Database tables, click the Options icon next to the Last updated column, and click Edit connection.
  3. On the Database connection page, update the connection details as required.
  4. Click Next.

Remove database table

To remove a database table source, complete the following steps:
  1. On the API Manager, navigate to Resources > API Assistant. The API Assistant source page opens.
  2. Under Database tables, click the Options icon next to the Last updated column, and click Remove.
    Note: Deleting a table will remove it from the UI and database, ensuring the data is inaccessible.