s/table/name/g

apache · Apr 18, 2024 · 0a622a6 · 0a622a6
1 parent 18bf8d6
commit 0a622a6
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 19 deletions.
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndFilterSelect.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndFilterSelect.tsx
@@ -181,7 +181,7 @@ const DndFilterSelect = (props: DndFilterSelectProps) => {
 
       if (!isSqllabView && dbId && name && schema) {
         SupersetClient.get({
-          endpoint: `/api/v1/database/${dbId}/table_metadata/extra/?table=${name}&schema=${schema}`,
+          endpoint: `/api/v1/database/${dbId}/table_metadata/extra/?name=${name}&schema=${schema}`,
         })
           .then(({ json }: { json: Record<string, any> }) => {
             if (json?.partitions) {

diff --git a/superset-frontend/src/explore/components/controls/FilterControl/AdhocFilterControl/index.jsx b/superset-frontend/src/explore/components/controls/FilterControl/AdhocFilterControl/index.jsx
@@ -143,7 +143,7 @@ class AdhocFilterControl extends React.Component {
 
       if (!isSqllabView && dbId && name && schema) {
         SupersetClient.get({
-          endpoint: `/api/v1/database/${dbId}/table_metadata/extra/?table=${name}&schema=${schema}`,
+          endpoint: `/api/v1/database/${dbId}/table_metadata/extra/?name=${name}&schema=${schema}`,
         })
           .then(({ json }) => {
             if (json && json.partitions) {

diff --git a/superset-frontend/src/hooks/apiResources/tables.ts b/superset-frontend/src/hooks/apiResources/tables.ts
@@ -126,8 +126,8 @@ const tableApi = api.injectEndpoints({
     >({
       query: ({ dbId, schema, table }) => ({
         endpoint: schema
-          ? `/api/v1/database/${dbId}/table_metadata/extra/?table=${table}&schema=${schema}`
-          : `/api/v1/database/${dbId}/table_metadata/extra/?table=${table}`,
+          ? `/api/v1/database/${dbId}/table_metadata/extra/?name=${table}&schema=${schema}`
+          : `/api/v1/database/${dbId}/table_metadata/extra/?name=${table}`,
         transformResponse: ({ json }: JsonResponse) => json,
       }),
     }),

diff --git a/superset/databases/api.py b/superset/databases/api.py
@@ -867,21 +867,23 @@ def table_extra_metadata(self, pk: int) -> FlaskResponse:
           - in: query
             schema:
               type: string
-            name: table
+            name: name
             required: true
             description: Table name
           - in: query
             schema:
               type: string
             name: schema
             description: >-
-              Optional table schema, if not passed default schema will be used
+              Optional table schema, if not passed the schema configured in the database
+              will be used
           - in: query
             schema:
               type: string
             name: catalog
             description: >-
-              Optional table catalog, if not passed default catalog will be used
+              Optional table catalog, if not passed the catalog configured in the
+              database will be used
           responses:
             200:
               description: Table extra metadata information
@@ -898,16 +900,15 @@ def table_extra_metadata(self, pk: int) -> FlaskResponse:
         """
         self.incr_stats("init", self.table_extra_metadata.__name__)
 
-        database = DatabaseDAO.find_by_id(pk)
-        if database is None:
+        if not (database := DatabaseDAO.find_by_id(pk)):
             raise DatabaseNotFoundException("No such database")
 
         try:
             parameters = QualifiedTableSchema().load(request.args)
         except ValidationError as ex:
             raise InvalidPayloadSchemaError(ex) from ex
 
-        table = Table(**parameters)
+        table = Table(parameters["name"], parameters["schema"], parameters["catalog"])
         try:
             security_manager.raise_for_access(database=database, table=table)
         except SupersetSecurityException as ex:

diff --git a/superset/databases/schemas.py b/superset/databases/schemas.py
@@ -1205,7 +1205,7 @@ class QualifiedTableSchema(Schema):
     present.
     """
 
-    table = fields.String(
+    name = fields.String(
         required=True,
         metadata={"description": "The table name"},
     )

diff --git a/tests/unit_tests/databases/api_test.py b/tests/unit_tests/databases/api_test.py
@@ -1188,27 +1188,27 @@ def test_table_extra_metadata_happy_path(
     mocker.patch("superset.databases.api.DatabaseDAO.find_by_id", return_value=database)
     mocker.patch("superset.databases.api.security_manager.raise_for_access")
 
-    response = client.get("/api/v1/database/1/table_metadata/extra/?table=t")
+    response = client.get("/api/v1/database/1/table_metadata/extra/?name=t")
     assert response.json == {"hello": "world"}
     database.db_engine_spec.get_extra_table_metadata.assert_called_with(
         database,
         Table("t"),
     )
 
-    response = client.get("/api/v1/database/1/table_metadata/extra/?table=t&schema=s")
+    response = client.get("/api/v1/database/1/table_metadata/extra/?name=t&schema=s")
     database.db_engine_spec.get_extra_table_metadata.assert_called_with(
         database,
         Table("t", "s"),
     )
 
-    response = client.get("/api/v1/database/1/table_metadata/extra/?table=t&catalog=c")
+    response = client.get("/api/v1/database/1/table_metadata/extra/?name=t&catalog=c")
     database.db_engine_spec.get_extra_table_metadata.assert_called_with(
         database,
         Table("t", None, "c"),
     )
 
     response = client.get(
-        "/api/v1/database/1/table_metadata/extra/?table=t&schema=s&catalog=c"
+        "/api/v1/database/1/table_metadata/extra/?name=t&schema=s&catalog=c"
     )
     database.db_engine_spec.get_extra_table_metadata.assert_called_with(
         database,
@@ -1236,7 +1236,7 @@ def test_table_extra_metadata_no_table(
                 "error_type": "INVALID_PAYLOAD_SCHEMA_ERROR",
                 "level": "error",
                 "extra": {
-                    "messages": {"table": ["Missing data for required field."]},
+                    "messages": {"name": ["Missing data for required field."]},
                     "issue_codes": [
                         {
                             "code": 1020,
@@ -1262,7 +1262,7 @@ def test_table_extra_metadata_slashes(
     mocker.patch("superset.databases.api.DatabaseDAO.find_by_id", return_value=database)
     mocker.patch("superset.databases.api.security_manager.raise_for_access")
 
-    client.get("/api/v1/database/1/table_metadata/extra/?table=foo/bar")
+    client.get("/api/v1/database/1/table_metadata/extra/?name=foo/bar")
     database.db_engine_spec.get_extra_table_metadata.assert_called_with(
         database,
         Table("foo/bar"),
@@ -1279,7 +1279,7 @@ def test_table_extra_metadata_invalid_database(
     """
     mocker.patch("superset.databases.api.DatabaseDAO.find_by_id", return_value=None)
 
-    response = client.get("/api/v1/database/1/table_metadata/extra/?table=t")
+    response = client.get("/api/v1/database/1/table_metadata/extra/?name=t")
     assert response.status_code == 404
     assert response.json == {
         "errors": [
@@ -1325,7 +1325,7 @@ def test_table_extra_metadata_unauthorized(
         ),
     )
 
-    response = client.get("/api/v1/database/1/table_metadata/extra/?table=t")
+    response = client.get("/api/v1/database/1/table_metadata/extra/?name=t")
     assert response.status_code == 404
     assert response.json == {
         "errors": [