GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves dictionary table information from a specified database within the GitLab Admin API. It is useful for administrators who need to query metadata about database tables, such as their structure or schema details, in GitLab's internal databases (e.g., 'main' or 'ci'). For example, an admin can use this operation to fetch details about a specific table in the 'main' database to understand its columns and data types.

Use Case Examples

  1. Fetch dictionary table details for the 'users' table in the 'main' database to audit schema changes.
  2. Retrieve metadata for a custom table in the 'ci' database to verify its structure before running maintenance scripts.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for testing or public endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the request, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Path Parameters Parameters specifying the database and table names to target in the API path.

Output

JSON

  • database_name - The name of the database queried.
  • table_name - The name of the table queried.
  • dictionary_table_info - The detailed dictionary information about the specified table returned by the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the database_name and table_name path parameters are correctly set and exist in the GitLab instance.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access admin database information.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common errors include 401 Unauthorized (invalid or missing API key), 404 Not Found (incorrect database or table name), and 500 Internal Server Error (server issues).

Links

Discussion