Database Console Guide

This page provides a clear and complete guide to the Database section of the Namirasoft Credential Console. The Database credential type is generic: it stores the connection details needed to reach almost any database engine, including host, port, authentication, SSL configuration, and an optional SSH tunnel. Use this guide to understand each field and configure secure database access for your Namirasoft applications.

What Is the Database Credential?

A Database credential stores everything Namirasoft needs to connect to a database on your behalf. Because the core connection fields (host, port, username, password, and SSL) are standard across most database engines, a single Database credential type can connect to many different systems without requiring a separate credential type for each one.

 

This means any database that exposes a host, port, and login, or a full connection string, can be registered here, not only the examples shown in the section below.

 

Why Secure Database Credential Management Matters

A database often contains essential operational and business data. Applications require authorized access to retrieve, insert, or update this data during runtime. Storing connection details manually inside application code, configuration files, or environment variables increases the risk of:

 

• Accidental credential exposure in logs or repositories

 

• Connecting to the wrong environment, such as production instead of staging

 

• Loss of control when credentials are shared across multiple services

 

• Lack of rotation or auditing when access needs to change

 

Without proper storage practices, these vulnerabilities can lead to data exposure or system compromise.

 

Overview of Database Fields and Options

The sections below explain each field in the Database credential form. Understanding these fields will help you define connection parameters correctly, validate access, and link your database to Namirasoft services with full clarity and control.

• ID (String): This is the unique identifier automatically generated by Namirasoft Credential when the database credential is created. You do not enter or modify this value. It is used internally for tracking, linking, and referencing the entry across the Namirasoft ecosystem.

• User ID (Namirasoft Account’s ID): This is the unique ID assigned to the Namirasoft Account that created the credential. It serves as a link between the credential and the user who owns or manages it.

• Workspace ID (Namirasoft Workspace’s ID): This refers to a workspace created in the Namirasoft Workspace app, which allows users to organize credentials by project, environment, or team. The workspace name is displayed along with the ID, and it links back to the Namirasoft Workspace app where the workspace details can be viewed.

• Name (String): This is a human friendly label you choose to identify the credential, such as Production Database or Reporting Server. It helps you and your team recognize which connection is which and has no impact on authentication itself.

• Database Name (String): This is the name of the specific database that Namirasoft applications should access on the server. A single server may host multiple databases, and this value ensures the correct one is selected when establishing the connection.

• SSH (Enum): This selects the SSH credential to use when the database is hosted inside a private network and cannot be reached directly. When set, Namirasoft connects through a secure SSH tunnel before opening the database connection. For details on setting up SSH credentials, see the SSH Console Guide.

• Type (Enum): This determines how the connection details are provided. Choose Parameters to enter the host, port, username, and password as separate fields, or choose Connection String to provide all connection details in a single URI. The fields shown in the form change based on this selection. The values you enter are encrypted and stored in Namirasoft Secret.

• • Parameters: Enter the connection details as individual fields.

• • • Host (String): This is the network address of the database server. Enter it as a public IP address, private IP address, or domain name, exactly as required to reach the server from the Namirasoft environment.

• • • Port (Integer): This is the network port the database listens on. Enter the port configured for your database engine.

• • • Username (String): This is the database account Namirasoft uses to authenticate. It must have the permissions needed to read or query the target database.

• • • Password (String): This is the password for the selected database user.

• • Connection String: Enter all connection details in a single URI instead of separate parameters.

• • • Connection String (String): This is the full URI containing the host, port, database name, and authentication details in a single value. For example: mysql://username:password@host:3306/database_name or postgresql://username:password@host:5432/database_name.

mysql://username:password@host:3306/database_name
postgresql://username:password@host:5432/database_name
clickhouse://username:password@host:8123/database_name

• Enable SSL (Checkbox): This enables encrypted communication between Namirasoft and the database server, protecting data in transit. Enable this option if your database requires or recommends SSL/TLS connections.

• CA (String): This is the Certificate Authority certificate used to verify the database server’s identity when SSL is enabled. It lets Namirasoft confirm it is connecting to the correct and trusted server, preventing man-in-the-middle attacks.

• Cert (String): This is the client certificate presented to the database server when mutual TLS authentication is required. It identifies Namirasoft to the server as a trusted client.

• Key (String): This is the private key associated with the client certificate. It completes the SSL handshake when mutual TLS is enabled.

• Description (String): This is an optional text field where you can document the purpose or environment of the credential, such as analytics database or staging access. Adding a description is helpful when working with multiple credentials in a shared workspace.

• Created At (DateTime): This shows the exact date and time when the database credential was first created. This value is automatically set when you create the record and does not change over time.

• Updated At (DateTime): This shows the exact date and time when the database credential was most recently modified. It helps you track when the credential was last maintained.