get-database-by-name
Retrieve detailed database information by providing a fully qualified name. Optionally filter fields and include deleted or non-deleted databases.
Instructions
Get database details by fully qualified name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fqn | Yes | Fully qualified name (e.g. 'service.database') | |
| fields | No | ||
| include | No |
Implementation Reference
- src/index.ts:187-187 (registration)Registration of the 'get-database-by-name' tool with MCP server using the schema and handler from databases.ts
tool("get-database-by-name", "Get database details by fully qualified name", getDatabaseByNameSchema.shape, wrapToolHandler(getDatabaseByName)); - src/tools/databases.ts:29-33 (schema)Zod schema defining input parameters: fqn (fully qualified name), optional fields, optional include filter
export const getDatabaseByNameSchema = z.object({ fqn: z.string().describe("Fully qualified name (e.g. 'service.database')"), fields: z.string().optional(), include: z.enum(["non-deleted", "deleted", "all"]).optional(), }); - src/tools/databases.ts:35-38 (handler)Handler function that constructs and sends a GET request to /databases/name/{fqn} using the OpenMetadata API client
export async function getDatabaseByName(params: z.infer<typeof getDatabaseByNameSchema>) { const { fqn, ...query } = params; return omClient.get(`/databases/name/${encodeURIComponent(fqn)}`, query); }