Database Service¶
Introduction¶
TCUP facilitates deployment and running of applications on its Application Deployment Service. At times these applications require a relational database for its use. TCUP Database Service provides a database infrastructure for such applications.
This service allows the application developers to use RDBMS (Postgres database) for storing data without taking the pain of provisioning a server and installing a separate database.
Developers can create their own database through a web interface or API. They can also upload SQL file and create or update schema.
Purpose of the Document¶
After going through this document the users will able to do the following activities using Database service portal.
Register a new postgres database
Update schema of the registered database
Drop the registered database if no longer required
Search required database.
Reference Document¶
Please refer to the following documents to get more details on Database Service
To understand the basic concepts of Database Service please refer to the Concept guide.
For API details please refer to the API guide.
Register a Database¶
Database can be registered by clicking the register button present at the top-right corner of the database portal page. On clicking the button a registration form opens up where the schema details have to be filled as described below:
1. DB Name
This is the name of the database.
2. User name
This is the role name to access the database.
3. Password
This is the password to access the database.
Note
All the three fields are mandatory.
Once the required fields are filled, the Register button becomes enabled.
Click the Register button. On successful registration, a confirmation message will be displayed and the schema will appear in the list of databases.
Update Schema by ID¶
The sql script (backup taken in plain format) can be run to update the schema. There is link to restore for each database record in the list as shown below.
On clicking, a popup form opens up prompting to upload the sql file. The DB password also has to be entered as shown in the image below.
Note
The backup file should be in plain format with .backup extension.
Once uploaded, click the Upload button. Users will receive a confirmation message after successful restoration.
Now the app can be connected and the user can query data.
Drop Database by ID¶
Registered Database can be dropped if it is not required any longer. Each database record in the list has a link for ‘Delete’ as shown in the image below.
On clicking, a popup will appear asking for confirmation.
After clicking the Delete button, a confirmation message will be received if the database is dropped successfully.
Client Side Free Text Search¶
Database portal offers free text client side search to search for the required database.
In the snapshot above there are three databases, on searching with text ener the list of databases with name containing the text ener will be seen.
