-
Notifications
You must be signed in to change notification settings - Fork 806
feat(tools/cloud-sql-mysql-list-tables)!: Add new tool for cloud-sql-mysql #1287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
1 similar comment
docs/en/resources/tools/cloudsqlmysql/cloud-sql-mysql-list-tables.md
Outdated
Show resolved
Hide resolved
51ddd85
to
eba2bf7
Compare
} | ||
|
||
func (t Tool) RequiresClientAuthorization() bool { | ||
return false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In other pull requests as well is this method required if it is always false
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it is throwing an error if this method is not implemented
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to scope this tool to Cloud SQL. This could be a MySQL tool under /internal/tools/mysql and support any MySQL source
type: docs | ||
weight: 1 | ||
description: > | ||
Tools that work with CloudSQL MySQL Sources. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cloud SQL should be 2 words. Please update everywhere
@@ -0,0 +1,7 @@ | |||
--- | |||
title: "CloudSQLMySQL" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use the full name Cloud SQL for MySQL
The `cloud-sql-mysql-list-tables` tool retrieves schema information for all or specified tables in a CloudSQL for MySQL database. | ||
It is compatible with [cloud-sql-mysql](../../sources/cloud-sql-mysql.md) source. | ||
|
||
`cloud-sql-mysql-list-tables` lists detailed schema information (object type, columns, constraints, indexes, triggers, owner, comment) as JSON for user-created tables (ordinary or partitioned). Filters by a comma-separated list of names. If names are omitted, it lists all tables in user schemas. The output format can be set to `simple` which will return only the table names or `detailed` which is the default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is nice, but we may want to standardize on a "## Parameters" section
} | ||
|
||
// validate compatible sources are still compatible | ||
var _ compatibleSource = &cloudsqlmysql.Source{} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be compatible with generic mySql as well
This should not be labeled as a breaking change |
Description
This pull request introduces a new custom tool kind
cloud-sql-mysql-list-tables
that allows users to list tables within a Cloud SQL for MySQL database.Example Configuration
Example Request
PR Checklist
CONTRIBUTING.md
bug/issue
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
!
if this involve a breaking change