From d1842f5b1b5718278a5c157c24a96d235489f72d Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Wed, 26 Feb 2025 14:01:21 +0000
Subject: [PATCH] Documentation edits made through Mintlify web editor
---
data-sources/bigquery.mdx | 68 ++++++++++++++++++++++++++++-
data-sources/postgres.mdx | 87 ++++++++++++++++++++++++++++++++++++-
data-sources/snowflake.mdx | 88 +++++++++++++++++++++++++++++++++++++-
docs.json | 20 ++++++---
snippets/card-styling.mdx | 21 +++++++++
5 files changed, 276 insertions(+), 8 deletions(-)
create mode 100644 snippets/card-styling.mdx
diff --git a/data-sources/bigquery.mdx b/data-sources/bigquery.mdx
index 095becf..9882309 100644
--- a/data-sources/bigquery.mdx
+++ b/data-sources/bigquery.mdx
@@ -3,4 +3,70 @@ title: 'BigQuery'
description: 'Connect your BigQuery data warehouse to Basedash'
---
-Connect your BigQuery data warehouse to Basedash to start querying and managing your data.
+
+ 
+
+
+Connect your BigQuery data warehouse to Basedash to start querying and managing your data efficiently and securely.
+
+
+ Before you begin, make sure you have admin access to your BigQuery project and the necessary credentials ready.
+
+
+
+
+ You'll need:
+ - A Google Cloud Project ID
+ - Service Account Key (JSON format)
+ - Appropriate IAM permissions set up
+
+
+
+ In Basedash:
+ 1. Navigate to **Data Sources**
+ 2. Click **+ Add New Source**
+ 3. Select **BigQuery** from the available connectors
+
+
+
+ Fill in the following required fields:
+ - Project ID
+ - Upload your Service Account Key
+ - (Optional) Set a custom connection name
+
+
+
+ - Click **Test Connection** to verify your credentials
+ - Ensure all necessary datasets are accessible
+ - Review any permission warnings
+
+
+
+
+
+ - Google Cloud Project with BigQuery API enabled
+ - Service account with `bigquery.dataViewer` role (minimum)
+ - Network access configured (if using VPC)
+
+
+
+ - Use dedicated service accounts for Basedash
+ - Implement least-privilege access principles
+ - Regularly rotate service account keys
+ - Monitor query usage through BigQuery audit logs
+
+
+
+
+
+ Contact our support team for assistance with your BigQuery connection setup.
+
+
+
+ Learn about our pricing plans and BigQuery-specific features.
+
+
+
+
+ For optimal performance, consider setting up a separate BigQuery project for Basedash connections and implementing appropriate usage quotas.
+
\ No newline at end of file
diff --git a/data-sources/postgres.mdx b/data-sources/postgres.mdx
index eab4a68..a1a58d2 100644
--- a/data-sources/postgres.mdx
+++ b/data-sources/postgres.mdx
@@ -3,4 +3,89 @@ title: 'PostgreSQL'
description: 'Connect your PostgreSQL database to Basedash'
---
-You can connect directly to your PostgreSQL database to visualize data from your product, like signups and customers.
+
+ 
+ 
+
+
+Connect your PostgreSQL database to Basedash to visualize and manage your product data seamlessly. Follow these simple steps to get started.
+
+
+
+ You'll need the following information to connect your PostgreSQL database:
+ - Host name or IP address
+ - Port number (default: 5432)
+ - Database name
+ - Username
+ - Password
+
+
+
+ Ensure your database is accessible from Basedash's IP addresses:
+
+ ```plaintext IP Addresses
+ 34.56.78.90
+ 12.34.56.78
+ 98.76.54.32
+ ```
+
+
+
+ If you're using AWS RDS, make sure to update your security group rules to allow incoming connections from these IPs.
+
+
+
+
+ In Basedash:
+ 1. Click on "Add Data Source"
+ 2. Select "PostgreSQL"
+ 3. Fill in your connection details
+ 4. Test the connection
+
+
+
+ Once connected, you can:
+
+
+ Write and execute SQL queries directly in Basedash
+
+
+ Build custom views for your team members
+
+
+ Control who can access what data
+
+
+ Monitor database changes over time
+
+
+
+
+
+
+
+ If you prefer using a connection string, use this format:
+ ```plaintext
+ postgresql://username:password@host:port/database
+ ```
+
+
+
+ For enhanced security, we recommend using SSL connections. You can enable SSL in your connection settings and provide your SSL certificate if required.
+
+
+
+ Common issues and solutions:
+ - **Connection timeout**: Check network access and firewall rules
+ - **Authentication failed**: Verify credentials and user permissions
+ - **Database not found**: Confirm database name and user access rights
+
+
+
+
+ For optimal performance, we recommend creating a read-only user specifically for Basedash connections.
+
+
+
+ Never share your database credentials or expose them in public repositories.
+
\ No newline at end of file
diff --git a/data-sources/snowflake.mdx b/data-sources/snowflake.mdx
index 734c560..26d94cd 100644
--- a/data-sources/snowflake.mdx
+++ b/data-sources/snowflake.mdx
@@ -3,4 +3,90 @@ title: 'Snowflake'
description: 'Connect your Snowflake data warehouse to Basedash'
---
-Connect your Snowflake data warehouse to Basedash to start querying and managing your data.
+# Connecting Snowflake to Basedash
+
+
+ 
+
+
+Connect your Snowflake data warehouse to Basedash to start querying and managing your data securely and efficiently.
+
+
+ Before you begin, make sure you have your Snowflake credentials ready and the necessary permissions to create database connections.
+
+
+
+
+ You'll need the following information from your Snowflake instance:
+ - Account identifier (including region)
+ - Username
+ - Password
+ - Warehouse name
+ - Database name
+ - Schema name (optional)
+
+
+
+
+
+ 1. Navigate to the Data Sources section in Basedash
+ 2. Click "Add New Connection"
+ 3. Select "Snowflake" from the available connectors
+ 4. Enter your account identifier and credentials
+
+
+
+ - **Connection Timeout**: Default is 10 seconds
+ - **Query Timeout**: Default is 60 seconds
+ - **SSL Mode**: Enabled by default for security
+ - **Role**: Specify a custom role if needed
+
+
+
+
+
+ Before finalizing the setup:
+ 1. Click "Test Connection" to verify your credentials
+ 2. Ensure you receive a success message
+ 3. Check that you can see your databases and schemas
+
+
+
+ Once connected, you can:
+ - Browse your Snowflake tables
+ - Create custom views
+ - Run SQL queries
+ - Manage data access permissions
+
+
+
+
+
+ - Use dedicated service accounts
+ - Implement proper role-based access
+ - Regularly rotate credentials
+ - Enable SSL encryption
+
+
+
+ - Check network connectivity
+ - Verify account permissions
+ - Validate warehouse availability
+ - Review error logs
+
+
+
+
+ For optimal performance, we recommend setting up a dedicated warehouse for Basedash queries.
+
+
+## Next Steps
+
+After connecting your Snowflake instance:
+1. [Set up user permissions](/settings/permissions)
+2. [Create your first view](/views/creating-views)
+3. [Invite team members](/team/invitations)
+
+
+ Remember to follow your organization's security policies when setting up database connections.
+
\ No newline at end of file
diff --git a/docs.json b/docs.json
index 7d82866..8d55759 100644
--- a/docs.json
+++ b/docs.json
@@ -15,11 +15,15 @@
"groups": [
{
"group": "Getting started",
- "pages": ["introduction"]
+ "pages": [
+ "introduction"
+ ]
},
{
"group": "Essentials",
- "pages": ["essentials/security"]
+ "pages": [
+ "essentials/security"
+ ]
}
]
},
@@ -33,12 +37,18 @@
"data-sources/mysql",
"data-sources/planetscale",
"data-sources/postgres",
- "data-sources/spanner"
+ "data-sources/spanner",
+ "data-sources/bigquery",
+ "data-sources/snowflake",
+ "data-sources/postgres"
]
},
{
"group": "Warehouses",
- "pages": ["data-sources/bigquery", "data-sources/snowflake"]
+ "pages": [
+ "data-sources/bigquery",
+ "data-sources/snowflake"
+ ]
}
]
}
@@ -71,4 +81,4 @@
"linkedin": "https://linkedin.com/company/Basedash"
}
}
-}
+}
\ No newline at end of file
diff --git a/snippets/card-styling.mdx b/snippets/card-styling.mdx
new file mode 100644
index 0000000..82d0be6
--- /dev/null
+++ b/snippets/card-styling.mdx
@@ -0,0 +1,21 @@
+
+
+
+ {props.icon && (
+
+
+
+ )}
+
{props.title}
+
+
+ {props.children}
+
+