Skip to main content
Focus: Configure your IDE environment with proper data warehouse connections, repository access, and development tools to start building data applications. Before you can start developing in the 5X IDE, you need to configure your data warehouse credentials and set up repositories. This guide walks you through the complete setup process for all supported data warehouses and repository types.
Setup RequirementsEnsure you have developer access to your 5X platform workspace and appropriate data warehouse privileges before beginning the setup process.

Prerequisites and access requirements

Required platform access

Before using the 5X IDE, ensure you have the necessary access and permissions:
  • Developer access to your 5X platform workspace
  • Data warehouse privileges (BigQuery, Snowflake, Redshift, or PostgreSQL)
  • Git repository access (if importing existing repositories)
The IDE is particularly powerful for dbt development, Python data applications, and Streamlit dashboards. Understanding your primary use cases will help you configure the environment optimally from the start.

Data warehouse requirements

Different warehouses have specific requirements:

BigQuery

Google Cloud setup requiredService account with BigQuery Data Editor role and JSON key file

Snowflake

Key pair authenticationPrivate key and passphrase for secure authentication

Redshift

Cluster accessCluster endpoint, database credentials, and network access

PostgreSQL

Server connectionHost, port, database name, and authentication credentials

Credential configuration

Accessing credential settings

Navigate to the IDE credential configuration:
1

Go to settings

Access Settings from the main navigation in your 5X platform
2

Select IDE section

Click on IDE in the settings menu, then select Credentials
3

Add new credential

Click Add New Credential against IDE (Beta) to start the configuration wizard
4

Choose warehouse type

Select your data warehouse type from the available options

Data warehouse setup examples

The IDE supports multiple data warehouses. Choose the setup process for your specific warehouse:
  • BigQuery
  • Snowflake
  • Redshift
  • PostgreSQL
Google BigQuery setupFor BigQuery users, you’ll need to create a service account with appropriate permissions:BigQuery IDE Credentials Setup
1

Create service account

Access Google Cloud Console → IAM & Admin → Create service account (e.g., “5x-ide-dev-account”)
2

Assign permissions

Assign the BigQuery Data Editor role for optimal functionality and security
3

Generate key file

Create and download the JSON key file for the service account
4

Upload credentials

Upload the key file through the 5X credential interface
Configuration fields:
  • Service Account Key: Upload your JSON key file
  • Project ID: Your BigQuery project identifier
  • dbt Version: Choose from available versions (1.6, 1.7, 1.8, 1.9)
  • Dataset Name: Target dataset for development workloads
  • Target Name: Optional custom target name for dbt profile
Permission scope options:
  • Project-level: Access across all datasets (recommended for development)
  • Dataset-level: Granular access control for sensitive data environments

Repository management

Repository integration benefits

The 5X platform maintains a registry of repositories accessible within your IDE environment. This integration enables advanced features like automatic lineage tracking, integrated documentation, and seamless deployment workflows. Key benefits of integration:
  • Automatic metadata extraction and dependency tracking
  • Consistent repository access across your workspace
  • Seamless deployment workflows to production environments

Creating new repositories

Navigate to Settings → IDE → Repositories → New Repository to access the repository configuration interface: IDE Repository Configuration

Repository types and templates

Choose the right template for your development needs:

dbt repository

Data transformation projectsPre-configured dbt project structure with sample models, tests, and documentation templates. Includes properly configured dbt_project.yml and basic macros.

General purpose

Custom developmentMaximum flexibility for Python applications or mixed-technology projects. Complete control over project organization and structure.

Streamlit repository

Interactive applicationsBasic Streamlit template with sample visualizations for data apps. Ready-to-use dashboard components and data visualization examples.

Repository management options

Fully managed Git repositoryCreates a fully managed Git repository within your 5X workspace:
  • Automatic backup and integrated version control
  • Seamless integration with all 5X platform features
  • Platform handles repository maintenance and access control
  • No external Git provider required
Best for: New projects, teams wanting integrated workflows, simplified repository management
Connect external repositoriesConnects external repositories while maintaining external Git provider relationships:
  • Requires SSH URL to existing repository
  • Supports public and private repositories with proper authentication
  • Maintains connection to GitHub, GitLab, Bitbucket, etc.
  • Full Git workflow preserved with external provider
Best for: Existing projects, teams using external Git providers, maintaining current workflows

Repository setup process

1

Choose repository type

Select from dbt, general purpose, or Streamlit repository templates based on your project needs
2

Configure repository settings

Choose between 5X managed repository or import existing repository
3

Set up Git integration

For existing repositories, provide SSH URL and configure authentication
4

Complete setup

Follow the configuration wizard to create your repository
5

Verify integration

Confirm repository appears in your IDE file explorer
Critical integration noteAlways create repositories through Settings → IDE → Repositories rather than using Git commands directly in the IDE terminal. Repositories created directly within the IDE won’t appear automatically in your 5X workspace registry.

Environment validation

Testing your setup

After configuring credentials and repositories, validate your setup:
1

Test data warehouse connection

Use the database explorer to verify you can connect to your warehouse
2

Verify repository access

Confirm repositories appear in the IDE file explorer
3

Test dbt configuration

Run a simple dbt command to verify dbt is properly configured
4

Check Python environment

Verify Python versions and virtual environment creation works

Common setup issues

Troubleshooting credential issues:
  • Verify service account permissions for BigQuery users
  • Check private key format for Snowflake users
  • Confirm network access for Redshift/PostgreSQL
  • Validate authentication credentials for all warehouse types
Repository integration issues:
  • Ensure repository created through Settings interface
  • Check SSH key configuration for external repositories
  • Verify repository permissions and access rights
  • Confirm repository URL is correct and accessible
dbt configuration problems:
  • Verify credential configuration matches dbt profile requirements
  • Check target dataset/schema exists and has write permissions
  • Confirm dbt version is compatible with your warehouse
  • Review dbt logs for specific error messages

Next steps

Once your IDE is properly configured, you’re ready to start developing:
I