> For the complete documentation index, see [llms.txt](https://docs.e6data.com/query-engine/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.e6data.com/query-engine/guides.md). # Guides - [Overview](https://docs.e6data.com/query-engine/guides/guides.md): Task-based guides for deploying, securing, connecting, and operating e6data - from workspace setup to querying. - [Table of contents](https://docs.e6data.com/query-engine/guides/guides/summary.md) - [Deployment](https://docs.e6data.com/query-engine/guides/deployment.md) - [AWS Serverless](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless.md): Deploy e6data as a Serverless workspace on AWS - the end-to-end path from creating a workspace to running your first query. - [Architecture](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/architecture.md): How a Serverless e6data deployment on AWS works - managed compute in e6data's account, your data read in place via a cross-account IAM role. - [Prerequisites](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/prerequisites.md): What you need before deploying a Serverless e6data workspace on AWS. - [Configure AWS access](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/configure-aws-access.md): Create the cross-account IAM role e6data uses to read your S3 data and Glue catalog, then register its ARN in e6data. - [Connect S3 and Glue](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/connect-s3-and-glue.md): Create an AWS Glue catalog over your S3 data in a Serverless e6data workspace, using the cross-account IAM role. - [Create cluster](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/create-cluster.md): Create and configure a cluster to run queries in a Serverless e6data workspace on AWS. - [Run first query](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/run-first-query.md): Confirm your Serverless e6data deployment on AWS works by running a query against your catalog. - [FAQs](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/faqs.md): Common questions about data access, permissions, and revocation for a Serverless e6data deployment on AWS. - [Troubleshooting](https://docs.e6data.com/query-engine/guides/deployment/aws-serverless/troubleshooting.md): Resolve common IAM, cross-account, and catalog connection errors in a Serverless e6data deployment on AWS. - [AWS In-VPC / CloudPrem](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc.md): Deploy e6data inside your own AWS VPC on Amazon EKS - the end-to-end CloudPrem deployment, from infrastructure to your first query. - [Architecture](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/architecture.md): How an In-VPC (CloudPrem) e6data deployment on AWS runs entirely inside your own VPC on EKS, with only admin and observability traffic reaching e6data. - [Prerequisites](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/prerequisites.md): Tools, access, and onboarding items required before an In-VPC e6data deployment on AWS. - [Configure registry, VPC, EKS, and networking](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/configure-registry-vpc-eks-networking.md): Build the AWS infrastructure (VPC, IAM, EKS, networking, ECR access) and install the Kubernetes platform components for an In-VPC e6data deployment. - [Deploy workspace and e6data](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/deploy-workspace-and-e6data.md): Create the workspace namespace and NodePool, deploy the e6data workspace components with Helm, wait for reconciliation, and configure DNS. - [Register catalog](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/register-catalog.md): Grant the In-VPC engine access to your data lake and register a catalog in your e6data workspace. - [Create cluster](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/create-cluster.md): Create a cluster in your In-VPC workspace to run queries on the EKS compute Karpenter provisions. - [Run first query](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/run-first-query.md): Validate an In-VPC e6data install by verifying the cluster and workspace components, then running your first query. - [Component versions and operations](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/component-versions-and-operations.md): The Kubernetes workloads an In-VPC e6data deployment runs, the resource footprint, and the operational pattern for installs and upgrades. - [Delete workspace](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/delete-workspace.md): Tear down an In-VPC e6data workspace and its AWS resources in the reverse order they were created. - [Security best practices](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/security-best-practices.md): Security best practices for hardening an e6data In Your VPC deployment on AWS - identity, network, and EKS configuration. - [FAQs](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/faqs.md): Frequently asked questions about deploying and operating e6data In Your VPC on AWS - networking, encryption, instance types, and Kubernetes setup. - [Troubleshooting](https://docs.e6data.com/query-engine/guides/deployment/aws-in-vpc/troubleshooting.md): Diagnose common issues in an In-VPC e6data deployment - scheduling, image pulls, the operator, reconciliation, Pod Identity, load balancers, and monitoring. - [Azure Serverless](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless.md): Deploy e6data as a Serverless workspace on Azure - the end-to-end path from creating a workspace to running your first query. - [Architecture](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/architecture.md): How a Serverless e6data deployment on Azure works - managed compute in e6data's subscription, your ADLS Gen2 data read keylessly via Workload Identity. - [Prerequisites](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/prerequisites.md): What you need before deploying a Serverless e6data workspace on Azure. - [Configure Azure access](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/configure-azure-access.md): Grant e6data keyless read access to your Azure storage - provision a User-Assigned Managed Identity and register it as a Storage Credential. - [Connect ADLS and catalog](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/connect-adls-and-catalog.md): Create a catalog over your ADLS Gen2 data in a Serverless e6data workspace on Azure, using a shared Storage Credential. - [Create cluster](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/create-cluster.md): Create and configure a cluster to run queries in a Serverless e6data workspace on Azure. - [Run first query](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/run-first-query.md): Confirm your Serverless e6data deployment on Azure works by running a query against your catalog. - [FAQs](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/faqs.md): Common questions about data access, permissions, and revocation for a Serverless e6data deployment on Azure. - [Troubleshooting](https://docs.e6data.com/query-engine/guides/deployment/azure-serverless/troubleshooting.md): Resolve common Managed Identity, federated-credential, and storage-access errors in a Serverless e6data deployment on Azure. - [Azure In-VPC / CloudPrem](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc.md): Deploy e6data inside your own Azure VNet on AKS - the end-to-end CloudPrem deployment, from infrastructure to your first query. - [Architecture](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/architecture.md): How an In-VPC (CloudPrem) e6data deployment on Azure runs inside your own VNet on AKS, with engine pods on your node pools and data in your subscription. - [Prerequisites](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/prerequisites.md): Tools, Azure permissions, outbound network access, and onboarding items required before an In-VPC e6data deployment on AKS. - [Configure registry, Kubernetes, and networking](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/configure-registry-kubernetes-networking.md): Build the Azure infrastructure (VNet, AKS, identities, ADLS storage) and install the Kubernetes platform components for an In-VPC e6data deployment on AKS. - [Deploy workspace and e6data](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/deploy-workspace-and-e6data.md): Deploy an e6data workspace on AKS - namespace, TLS, service accounts and RBAC, NamespaceConfig, QueryRouter, and DNS, using explicit kubectl and YAML. - [Register catalog](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/register-catalog.md): Grant the In-VPC engine access to your data and register a catalog in your Azure-hosted e6data workspace. - [Create cluster](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/create-cluster.md): Create a cluster in your Azure In-VPC workspace to run queries on the AKS compute you provisioned. - [Run first query](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/run-first-query.md): Validate an Azure In-VPC e6data install by verifying the workspace pods, then running your first query. - [Component versions and operations](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/component-versions-and-operations.md): Component versions for the Azure In-VPC deployment, the Kubernetes workloads it runs, how to upgrade them, the upgrade order, and how to roll back. - [Delete workspace](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/delete-workspace.md): Tear down an e6data workspace in your AKS cluster with kubectl and az, and what to intentionally leave in place. - [Troubleshooting](https://docs.e6data.com/query-engine/guides/deployment/azure-in-vpc/troubleshooting.md): Common issues when deploying or running e6data In Your VPC on Azure, with diagnostic commands and fixes. - [Workspaces](https://docs.e6data.com/query-engine/guides/workspaces.md): A workspace is an isolated environment for a team or project - its own catalogs, clusters, access control, and run history. - [Create and manage workspaces](https://docs.e6data.com/query-engine/guides/workspaces/create-and-manage-workspaces.md): Create a workspace in the e6data Console - pick Serverless or In Your VPC, your cloud and region - and update it when a new version is released. - [Workspace settings](https://docs.e6data.com/query-engine/guides/workspaces/workspace-settings.md): Enable or disable a workspace - what each does, when to use it, and how it differs from deleting. - [Delete workspace](https://docs.e6data.com/query-engine/guides/workspaces/delete-workspace.md): Permanently delete a workspace from the e6data Console after detaching its clusters, catalogs, and endpoints. - [Security](https://docs.e6data.com/query-engine/guides/security.md) - [Identity and RBAC](https://docs.e6data.com/query-engine/guides/security/identity-and-rbac.md): How e6data controls who can access your platform and what they can do, across the Control Plane and the Compute Plane. - [Control Plane vs Compute Plane permissions](https://docs.e6data.com/query-engine/guides/security/identity-and-rbac/control-plane-vs-compute-plane-permissions.md): The two permission grammars in e6data - Control Plane named permissions and Compute Plane resource-and-action rules - and how roles and bindings compose them. - [Users, groups, and service accounts](https://docs.e6data.com/query-engine/guides/security/identity-and-rbac/users-groups-service-accounts.md): How human users, groups, and service accounts are created, synced to workspaces, and managed in e6data. - [Roles and permissions](https://docs.e6data.com/query-engine/guides/security/identity-and-rbac/roles-and-permissions.md): The built-in Admin, Manager, and Viewer roles, what each can do, and how to design custom roles in e6data. - [Access tokens](https://docs.e6data.com/query-engine/guides/security/access-tokens.md): How people and applications authenticate to an e6data workspace with access tokens - the credential types, what they carry, and how token auth relates to RBAC. - [Personal access tokens and service account keys](https://docs.e6data.com/query-engine/guides/security/access-tokens/pat-and-service-account-keys.md): The two e6data credential types in detail - personal access tokens and service account keys - their formats and when to use each. - [Create, use, rotate, and revoke tokens](https://docs.e6data.com/query-engine/guides/security/access-tokens/create-use-rotate-revoke.md): Create personal access tokens and service account API keys, use them over REST and JDBC/ODBC, set an expiry, rotate, and revoke them. - [Token security best practices](https://docs.e6data.com/query-engine/guides/security/access-tokens/token-security-best-practices.md): How to store e6data tokens safely, scope them with least privilege, revoke them, manage them as an admin, and understand what the audit trail records. - [Authentication](https://docs.e6data.com/query-engine/guides/security/authentication.md): How users sign in to e6data - local accounts, single sign-on, and TLS. - [SSO setup](https://docs.e6data.com/query-engine/guides/security/authentication/sso-setup.md): Connect your identity provider to e6data via SAML 2.0 or OIDC so members sign in with corporate credentials, with just-in-time provisioning. - [Domain auto-join and JIT provisioning](https://docs.e6data.com/query-engine/guides/security/authentication/domain-auto-join-and-jit.md): Let users join your organization automatically by email domain, and provision SSO users just-in-time on first sign-in. - [TLS certificates](https://docs.e6data.com/query-engine/guides/security/authentication/tls-certificates.md): How TLS certificates work for e6data endpoints - Serverless (managed by e6data) vs In-VPC (managed by you). - [Support access](https://docs.e6data.com/query-engine/guides/security/support-access.md): How e6data Support Users work - scoped, aliased, fully audited e6data engineer access that you can revoke at any time. - [Enable, audit, and block support access](https://docs.e6data.com/query-engine/guides/security/support-access/enable-audit-block.md): Add, block, unblock, and list e6data Support Users over the API, the permissions required, and how their actions appear in your audit log. - [Privacy controls](https://docs.e6data.com/query-engine/guides/security/support-access/privacy-controls.md): The per-tenant alias model behind e6data Support Users - how identities stay private, how audit history stays correct, and the security guarantees. - [Catalogs](https://docs.e6data.com/query-engine/guides/catalogs.md) - [Register and manage catalogs](https://docs.e6data.com/query-engine/guides/catalogs/register-and-manage-catalogs.md) - [Hive Metastore](https://docs.e6data.com/query-engine/guides/catalogs/hive-metastore.md) - [Set up a Hive Metastore](https://docs.e6data.com/query-engine/guides/catalogs/set-up-hive-metastore.md): Step-by-step guide to setting up a Hive Metastore with Terraform if you don't already have one. - [AWS Glue Catalog](https://docs.e6data.com/query-engine/guides/catalogs/aws-glue-catalog.md) - [Unity Catalog](https://docs.e6data.com/query-engine/guides/catalogs/unity-catalog.md) - [Microsoft Fabric](https://docs.e6data.com/query-engine/guides/catalogs/microsoft-fabric.md) - [Apache Polaris](https://docs.e6data.com/query-engine/guides/catalogs/apache-polaris.md) - [Iceberg REST Catalog](https://docs.e6data.com/query-engine/guides/catalogs/iceberg-rest-catalog.md) - [Amazon S3 Tables](https://docs.e6data.com/query-engine/guides/catalogs/amazon-s3-tables.md) - [Cross-account access](https://docs.e6data.com/query-engine/guides/catalogs/cross-account.md) - [Cross-account access to AWS Glue](https://docs.e6data.com/query-engine/guides/catalogs/cross-account/aws-glue.md): Connect an e6data workspace to an AWS Glue metastore and S3 data in a different AWS account. - [Cross-account access to a Hive Metastore (AWS)](https://docs.e6data.com/query-engine/guides/catalogs/cross-account/aws-hive-metastore.md): Connect an e6data workspace to a Hive Metastore and S3 data in a different AWS account. - [Cross-account access to Unity Catalog](https://docs.e6data.com/query-engine/guides/catalogs/cross-account/unity-catalog.md): Connect an e6data workspace to a Unity Catalog and S3 data in a different cloud account. - [Troubleshooting catalogs](https://docs.e6data.com/query-engine/guides/catalogs/troubleshooting-catalogs.md): Resolve common catalog connection, cross-account, and refresh failures in e6data. - [Table formats](https://docs.e6data.com/query-engine/guides/table-formats.md) - [Iceberg](https://docs.e6data.com/query-engine/guides/table-formats/iceberg.md) - [Delta Lake](https://docs.e6data.com/query-engine/guides/table-formats/delta-lake.md): How e6data queries Delta Lake tables through external catalogs, what's supported, and how to connect. - [Hive tables](https://docs.e6data.com/query-engine/guides/table-formats/hive-tables.md): How e6data queries Hive tables through a Hive Metastore or compatible catalog. - [Data governance](https://docs.e6data.com/query-engine/guides/data-governance.md): How e6data governs access to data within a catalog - catalog-level access control, column masking, and row filtering, enforced deny-by-default. - [Catalog-level access control](https://docs.e6data.com/query-engine/guides/data-governance/catalog-level-access-control.md): Grant or deny query access at the catalog, database, table, and column level with allow and deny privileges. - [Data access policies](https://docs.e6data.com/query-engine/guides/data-governance/data-access-policies.md): Apply column masking and row filtering to control which data users can see within a catalog. - [Relationship to platform RBAC](https://docs.e6data.com/query-engine/guides/data-governance/relationship-to-platform-rbac.md): How data governance and platform RBAC differ and work together - who can do what vs. which data they can see. - [FAQs](https://docs.e6data.com/query-engine/guides/data-governance/faqs.md): Frequently asked questions about catalog privileges and data access policies in e6data. - [Clusters](https://docs.e6data.com/query-engine/guides/clusters.md) - [Create and manage clusters](https://docs.e6data.com/query-engine/guides/clusters/create-and-manage-clusters.md): Create a cluster, configure its settings, connect to it, and manage its version and lifecycle. - [Cluster sizing and scaling](https://docs.e6data.com/query-engine/guides/clusters/cluster-sizing-and-scaling.md): Choose a cluster sizing and scaling mode - fixed, autoscaling, QPS-based, or scale-to-zero - plus execution modes and result caching. - [Suspend and resume](https://docs.e6data.com/query-engine/guides/clusters/suspend-and-resume.md): How clusters suspend to save cost and resume automatically when a query arrives - auto-suspend, manual suspend, auto-resume, and what's preserved. - [Lifecycle states and error codes](https://docs.e6data.com/query-engine/guides/clusters/lifecycle-states-and-error-codes.md): The cluster lifecycle states and the customer-facing error codes, with what each means and what to do. - [Zero-downtime upgrades](https://docs.e6data.com/query-engine/guides/clusters/zero-downtime-upgrades.md): How e6data upgrades a cluster's version without interrupting queries, and how it recovers if the new version is unhealthy. - [CloudPrem cluster operations](https://docs.e6data.com/query-engine/guides/clusters/cloudprem-cluster-operations.md): Manage e6data clusters in an In-VPC deployment with Kubernetes CRDs, kubectl, and GitOps - create, configure, scale, suspend, upgrade, and inspect. - [Troubleshooting clusters](https://docs.e6data.com/query-engine/guides/clusters/troubleshooting-clusters.md): Common cluster problems - stuck states, timeouts, degraded executors, and connection issues - with fixes. - [Querying](https://docs.e6data.com/query-engine/guides/querying.md) - [Query editor](https://docs.e6data.com/query-engine/guides/querying/query-editor.md): Write, format, and run SQL in the e6data Query Editor - tabs, the query action bar, the SQL editor, and the Schema Explorer. - [Run queries and view results](https://docs.e6data.com/query-engine/guides/querying/run-queries-and-view-results.md): Run SQL in the e6data Query Editor, track query status, view and export results, inspect execution details, and preview data. - [Query history and saved queries](https://docs.e6data.com/query-engine/guides/querying/query-history-and-saved-queries.md): Review every query run in a workspace in Run History - timing, status, user, and query text - and get query counts programmatically. - [Query performance basics](https://docs.e6data.com/query-engine/guides/querying/query-performance-basics.md): Practical levers for faster, cheaper queries in e6data - sizing, caching, execution mode, the transpiler, and reading execution details. - [Operations](https://docs.e6data.com/query-engine/guides/operations.md) - [Upgrades and releases](https://docs.e6data.com/query-engine/guides/operations/upgrades-and-releases.md): How administrators choose software versions and roll out upgrades across e6data - clusters, products, and platform components. - [Version selection and admin guide](https://docs.e6data.com/query-engine/guides/operations/upgrades-and-releases/version-selection-and-admin-guide.md): How workspace administrators select versions, refresh the available-version list, enable products, and grant upgrade permissions. - [Product and cluster upgrades](https://docs.e6data.com/query-engine/guides/operations/upgrades-and-releases/product-and-cluster-upgrades.md): Step-by-step upgrades for each surface - a cluster's version, a product version, and a platform components release. - [Rollbacks, failure modes, and recovery](https://docs.e6data.com/query-engine/guides/operations/upgrades-and-releases/rollbacks-failure-modes-recovery.md): How cluster and platform rollouts behave, how automatic rollback works, expected downtime, and what to do when an upgrade fails. - [Status signals](https://docs.e6data.com/query-engine/guides/operations/upgrades-and-releases/status-signals.md): Where each upgrade surface reports progress - cluster status and Activity History, product rows, and the Platform Components section. - [Monitoring](https://docs.e6data.com/query-engine/guides/operations/monitoring.md): Monitor cluster health, query performance, and resource utilization from the Compute Plane, and export telemetry to your own stack. - [Health checks](https://docs.e6data.com/query-engine/guides/operations/monitoring/health-checks.md): Confirm a workspace and its clusters are healthy - what to check in the Console and, for In-VPC, in your Kubernetes cluster. - [Metrics and alerts](https://docs.e6data.com/query-engine/guides/operations/monitoring/metrics-and-alerts.md): The metrics e6data exposes, the dashboards worth building, and the alerts to set on your observability stack. - [Observability export](https://docs.e6data.com/query-engine/guides/operations/monitoring/observability-export.md): Export e6data telemetry to your own observability stack via OpenTelemetry - metrics, logs, and traces. - [Account & users](https://docs.e6data.com/query-engine/guides/account-and-users.md) - [Account and user profile](https://docs.e6data.com/query-engine/guides/account-and-users/account-and-user-profile.md): View and edit your e6data profile - name, email, user ID, organization, and roles. - [Account settings](https://docs.e6data.com/query-engine/guides/account-and-users/account-settings.md): Manage your e6data account and user settings - profile details, and personal access tokens. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.e6data.com/query-engine/guides.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.