QuickSight general clean up.

Author: ywang103

README.md

@@ -44,10 +44,30 @@ df = wr.s3.read_parquet("s3://bucket/dataset/", dataset=True)
 df = wr.athena.read_sql_query("SELECT * FROM my_table", database="my_db")
 
 # Getting Redshift connection (SQLAlchemy) from Glue Catalog Connections
-engine = wr.catalog.get_engine("my-redshift-connection")
-
 # Retrieving the data from Amazon Redshift Spectrum
+engine = wr.catalog.get_engine("my-redshift-connection")
 df = wr.db.read_sql_query("SELECT * FROM external_schema.my_table", con=engine)
+
+# Creating QuickSight Data Source and Dataset to reflect our new table
+wr.quicksight.create_athena_data_source("athena-source", allowed_to_manage=["username"])
+wr.quicksight.create_athena_dataset(
+    name="my-dataset",
+    database="my_db",
+    table="my_table",
+    data_source_name="athena-source",
+    allowed_to_manage=["username"]
+)
+
+# Getting MySQL connection (SQLAlchemy) from Glue Catalog Connections
+# Load the data into MySQL
+engine = wr.catalog.get_engine("my-mysql-connection")
+wr.db.to_sql(df, engine, schema="test", name="my_table") 
+
+# Getting PostgreSQL connection (SQLAlchemy) from Glue Catalog Connections
+# Load the data into PostgreSQL
+engine = wr.catalog.get_engine("my-postgresql-connection")
+wr.db.to_sql(df, engine, schema="test", name="my_table") 
+
 ```
 
 ## [Read The Docs](https://aws-data-wrangler.readthedocs.io/)
@@ -80,13 +100,15 @@ df = wr.db.read_sql_query("SELECT * FROM external_schema.my_table", con=engine)
   - [015 - EMR](https://github.com/awslabs/aws-data-wrangler/blob/master/tutorials/015%20-%20EMR.ipynb)
   - [016 - EMR & Docker](https://github.com/awslabs/aws-data-wrangler/blob/master/tutorials/016%20-%20EMR%20%26%20Docker.ipynb)
   - [017 - Partition Projection](https://github.com/awslabs/aws-data-wrangler/blob/master/tutorials/017%20-%20Partition%20Projection.ipynb)
+  - [018 - QuickSight](https://github.com/awslabs/aws-data-wrangler/blob/master/tutorials/018%20-%20QuickSight.ipynb)
 - [**API Reference**](https://aws-data-wrangler.readthedocs.io/en/latest/api.html)
   - [Amazon S3](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#amazon-s3)
   - [AWS Glue Catalog](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#aws-glue-catalog)
   - [Amazon Athena](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#amazon-athena)
   - [Databases (Redshift, PostgreSQL, MySQL)](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#databases-redshift-postgresql-mysql)
   - [EMR Cluster](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#emr-cluster)
   - [CloudWatch Logs](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#cloudwatch-logs)
+  - [QuickSight](https://aws-data-wrangler.readthedocs.io/en/latest/api.html#quicksight)
 - [**License**](https://github.com/awslabs/aws-data-wrangler/blob/master/LICENSE)
 - [**Contributing**](https://github.com/awslabs/aws-data-wrangler/blob/master/CONTRIBUTING.md)
 - [**Legacy Docs** (pre-1.0.0)](https://aws-data-wrangler.readthedocs.io/en/legacy/)

awswrangler/quicksight/_create.py

@@ -53,7 +53,8 @@
 
 
 def _generate_principal(user_name: str, account_id: str, region: str) -> str:
-    return f"arn:aws:quicksight:{region}:{account_id}:user/default/{user_name}"
+    user_name = user_name if "/" in user_name else f"default/{user_name}"
+    return f"arn:aws:quicksight:{region}:{account_id}:user/{user_name}"
 
 
 def _generate_permissions(
@@ -273,6 +274,8 @@ def create_athena_dataset(
         raise exceptions.InvalidArgument("You must pass a not None data_source_name or data_source_arn argument.")
     if ((database is None) and (table is None)) and (sql is None):
         raise exceptions.InvalidArgument("You must pass database/table OR sql argument.")
+    if (database is not None) and (sql is not None):
+        raise exceptions.InvalidArgument("If you provide sql argument, please include the database name inside the sql statement. Do NOT pass in with database argument.")
     session: boto3.Session = _utils.ensure_session(session=boto3_session)
     client: boto3.client = _utils.client(service_name="quicksight", session=session)
     if account_id is None:
@@ -363,8 +366,8 @@ def create_ingestion(
 
     Returns
     -------
-    Current status
-        'INITIALIZED'|'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'CANCELLED'
+    str
+        Ingestion ID
 
     Examples
     --------
@@ -384,4 +387,4 @@ def create_ingestion(
     response: Dict[str, Any] = client.create_ingestion(
         DataSetId=dataset_id, IngestionId=ingestion_id, AwsAccountId=account_id
     )
-    return response["IngestionStatus"]
+    return response["IngestionId"]

docs/source/index.rst

@@ -26,11 +26,30 @@ Quick Start
     df = wr.athena.read_sql_query("SELECT * FROM my_table", database="my_db")
 
     # Getting Redshift connection (SQLAlchemy) from Glue Catalog Connections
-    engine = wr.catalog.get_engine("my-redshift-connection")
-
     # Retrieving the data from Amazon Redshift Spectrum
+    engine = wr.catalog.get_engine("my-redshift-connection")
     df = wr.db.read_sql_query("SELECT * FROM external_schema.my_table", con=engine)
 
+    # Creating QuickSight Data Source and Dataset to reflect our new table
+    wr.quicksight.create_athena_data_source("athena-source", allowed_to_manage=["username"])
+    wr.quicksight.create_athena_dataset(
+        name="my-dataset",
+        database="my_db",
+        table="my_table",
+        data_source_name="athena-source",
+        allowed_to_manage=["username"]
+    )
+
+    # Getting MySQL connection (SQLAlchemy) from Glue Catalog Connections
+    # Load the data into MySQL
+    engine = wr.catalog.get_engine("my-mysql-connection")
+    wr.db.to_sql(df, engine, schema="test", name="my_table")
+
+    # Getting PostgreSQL connection (SQLAlchemy) from Glue Catalog Connections
+    # Load the data into PostgreSQL
+    engine = wr.catalog.get_engine("my-postgresql-connection")
+    wr.db.to_sql(df, engine, schema="test", name="my_table")
+
 Read The Docs
 -------------