listTable

Search and retrieve database table metadata in Alibaba Cloud DMS using a specific database ID and table name. Supports pagination for managing large result sets efficiently.

Instructions

      Search for database tables in DMS based on databaseId and tableName.
      This tool allows searching for database tables in the DMS if databaseId is known. 
      If you don't known databaseId, you could obtained via getDatabase tool.
      Parameters:
        database_id (str): Required databaseId (obtained via getDatabase tool) to scope the search.
        search_name (str): A non-empty string used as the search keyword. Used to match table names.
        page_number (int, optional): Pagination page number (default: 1).
        page_size (int, optional): Number of results per page (default: 200, max: 200).
      Returns:
        Dict[str, Any] containing:
          TableList (Dict): Container for matching tables with structure:
            Table (List[Dict]): Array of table metadata objects containing:
              - DatabaseId (int): ID of parent database
              - TableGuid (str): Unique table identifier, with format: dmsTableId.schemaName.tableName.
              - TableName (str): Name of table
              - Description (str): Table description
              - TableType (str): Type classification (NORMAL/VIEW/etc.)
          TotalCount (int): Total number of matching tables across all pages

      

Input Schema

Name	Required	Description	Default
`database_id`	Yes
`page_number`	No
`page_size`	No
`search_name`	Yes

Input Schema (JSON Schema)

{
  "properties": {
    "database_id": {
      "title": "Database Id",
      "type": "string"
    },
    "page_number": {
      "default": 1,
      "title": "Page Number",
      "type": "integer"
    },
    "page_size": {
      "default": 200,
      "title": "Page Size",
      "type": "integer"
    },
    "search_name": {
      "title": "Search Name",
      "type": "string"
    }
  },
  "required": [
    "database_id",
    "search_name"
  ],
  "title": "listTablesArguments",
  "type": "object"
}

Alibaba Cloud DMS MCP Server

listTable

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Alibaba Cloud DMS MCP Server

Related Tools