Skip to content

kdb Insights

Data Access

Initializing search

Home
kdb Insights SDK
kdb Insights Enterprise
APIs
Licensing
Product Support

kdb Insights

Home
kdb Insights SDK
kdb Insights SDK
- Home
- Get Started
  Get Started
  - Prerequisites
  - Tutorials
    Tutorials
    
    Streaming to a web-socket client
- Core
  Core
  - About
  - Install
  - Object storage
    Object storage
    
    About
    
    Quickstart
    
    Caching
    
    Examples
  - SQL
    SQL
    
    About
    
    SQL Reference
    SQL Reference
    
    Operators
    
    Functions
    
    Data and Literals
    
    Select Statements
    
    Table Creation
    
    ANSI SQL Compliance
  - Postgres SQL Interface
  - REST API
    REST API
    
    Client
    Client
    
    About
    
    Quickstart
    
    Workflows
    
    Examples
    Examples
    
    Async
    
    Follow redirects
    
    Response headers
    
    Timeouts
    
    Azure API Management
    
    GCP Identity Aware Proxy
    
    Server
    Server
    
    About
    
    Quickstart
    
    API reference
    
    Examples
    Examples
    
    customers
    
    queryclient
    
    queryserver
    
    queryworker
    
    OpenAPI Sample
  - Google BigQuery API
    Google BigQuery API
    
    About
    
    Quickstart
    
    Main
    
    Discovery
    
    Query
    
    Projects
    
    Datasets
    
    Tables
    
    Tabledata
    
    Helpers
    
    Configuration
    
    API
    
    Troubleshooting
  - Packaging
    Packaging
    
    About
    
    Quickstart
    
    Examples
    Examples
    
    About the examples
    
    Basic Tick
    
    Hello C
    
    Labeling
  - Logging
    Logging
    
    About
    
    Quickstart
    
    API reference
  - Machine Learning
    Machine Learning
    
    About
    
    Quickstart
    Quickstart
    
    Docker
    
    Kubernetes
    
    Examples
    Examples
    
    Model Generation & Deployment
  - Release notes
    Release notes
    
    Latest
    
    Previous
- Database
  Database
  - Overview
  - Data Configuration
    Data Configuration
    
    Overview
    
    Routing
    
    Assembly
    Assembly
    
    Database
    
    Schema
    
    Storage
    
    Query
    
    Stream
    
    Aggregation
    
    User-Defined Analytics
    User-Defined Analytics
    
    Overview
    
    Configuration
    
    Quickstart
    
    Testing a UDA
    
    UDA Examples
    
    Troubleshooting
    
    Best Practices
    
    Advanced
    
    Advanced
    Advanced
    
    Overview
    
    Query scaling
    
    Authorization
    Authorization
    
    Custom IPC Authorization
    
    Custom HTTP Authorization
  - Data Storage
    Data Storage
    
    Overview
    
    Storage Tiering
    
    Object Storage
    
    Delete Rows
    
    Backup and Restore
    
    Event Hooks
  - Data Import
    Data Import
    
    Import Overview
    
    Initial Import
    Initial Import
    
    Overview
    
    Prerequisites
    
    Quickstart
    
    Initial Import Process
    
    Schema Creation
    
    Troubleshooting
    
    Batch Ingest
  - Data Query
    Data Query
    
    Overview
    
    Purviews
    
    Scope
    
    Late data
    
    Reference data
    
    Routing
    
    Queueing, retries, and timeouts
    
    Resilience
    
    Logging
    
    Troubleshooting
    
    Advanced
    Advanced
    
    Query existing object storage
  - Querying methods
    Querying methods
    
    Overview
    
    REST vs QIPC
    
    SQL
  - Monitoring
  - Best practices
    Best practices
    
    Late Data
    
    Manual EOD Trigger
    
    Performance
    
    Query
    
    Sizing
  - Deploying
    Deploying
    
    Overview
    
    Docker
    Docker
    
    Basic
  - Downgrading
  - Glossary
- Stream Processor
  Stream Processor
  - About Streaming Data
  - Quickstart
    Quickstart
    
    Docker
    
    Kubernetes
  - Writing
  - Running
  - Configuration
  - Troubleshooting
  - Guides
    Guides
    
    Object storage ingestion
    
    Database ingestion
    
    Reader Triggering
    
    kdb Insights Streams
  - Examples
    Examples
    
    Static file
    
    Batch S3 ingestion
    
    Kafka
    Kafka
    
    Getting started
    
    Setup Kafka
    
    Basic ingestion
    
    Setup Kafka TLS
    
    Ingestion with TLS
    
    PostgreSQL Querying
    
    Pipeline Replicas
    
    Stateful operators
    
    Enriching streams
    
    Windowing on event time
    
    Windowing on processing time
    
    kdb+ tick (callback)
  - Concepts
    Concepts
    
    Checkpoints and recovery
    
    Determinism
    
    Glob patterns
    
    Scaling
    
    Securing pipeline credentials
    
    State
- Reliable Transport
  Reliable Transport
  - About
  - Quickstart
    Quickstart
    
    About
    
    Docker
    
    Kubernetes
  - Publishers
    Publishers
    
    Overview
  - Subscribers
  - Interfaces
    Interfaces
    
    Getting started
    
    C
    C
    
    Using the C interface
    
    C samples
    
    Java
    Java
    
    Using the Java interface
    
    Java samples
    
    Python
    Python
    
    Using the Python interface
    
    Python samples
    
    q (rt.qpk)
    
    C#
    C#
    
    Using the C# interface
    
    C# samples
  - Examples
    Examples
    
    Publishing and Subscribing to Enterprise using q
    
    Recovering archived logs
    
    Running RT outside of a container
  - Configuration
    Configuration
    
    Overview
    
    Diagnostics
    
    Monitoring
  - Administration
    Administration
    
    Soft reset
    
    Hard reset
- Release notes
  Release notes
  - Latest
  - Previous
- Help and Support
  Help and Support
  - Product Support
  - Troubleshooting
    Troubleshooting
    
    Reliable Transport
kdb Insights Enterprise
kdb Insights Enterprise
- Home
- Deploy
  Deploy
  - Deployment Options
  - Standalone Deployments
    Standalone Deployments
    
    Infrastructure
    Infrastructure
    
    K8S Managed
    K8S Managed
    
    Prerequisites
    
    Azure User Node Pool Sizing
    
    Terraform
    Terraform
    
    Deployment Overview
    
    Deploy on GCP
    
    Deploy on AWS
    
    Deploy on Azure
    
    Upgrade Kubernetes Cluster
    
    Upgrade Third-party Dependencies
    
    Ingress Controller Change
    
    Interact with Kubernetes
    
    DNS setup
    
    K8S On-Prem Prerequisites
    
    OpenShift On-Prem Prerequisites
    
    Installation
    Installation
    
    Installing
    
    Validation
    
    Air-gapped environments
- Get Started
  Get Started
  - About kdb Insights Enterprise
  - Free Trial
    Free Trial
    
    7-day Free Trial
    
    Product Tour
  - Interfaces
  - CLI
    CLI
    
    Installation
    
    Configuration
    
    Authentication
- Learn
  Learn
  - Architecture
  - Language Interfaces
  - Command Line Interface
  - kdb VS Code Extension
  - Package Overview
  - Web Interface Guide
    Web Interface Guide
    
    About
    
    Log into kdb Insights Enterprise
    
    Navigate the Web Interface
    
    System Information
    
    Databases
    Databases
    
    Create and Manage
    
    Database Settings
    
    Schema Settings
    
    Stream Settings
    
    Database Resources
    
    Deploy/Teardown/Cleanup
    
    Pipelines
    Pipelines
    
    Import Wizard
    
    Create and Configure
    
    Settings
    
    Operators
    Operators
    
    Overview
    
    Readers
    
    Decoders
    
    Functions
    
    Transform
    
    Windows
    
    String Utilities
    
    Stats
    
    Machine Learning
    
    Encoders
    
    Writers
    
    Test Deploy
    
    Queries
    Queries
    
    Queries Index
    
    Query Window
    
    Query Panel
    
    Scratchpad
    
    Scratchpad using q
    
    Scratchpad using Python
    
    Views
    Views
    
    About
    
    Guide to Building Views
    
    View-Only User
    
    Packages
  - Store Data
    Store Data
    
    Database Overview
    
    Database Setup
    
    Database Storage
    
    Storage Tiers
    
    Best Practices
    Best Practices
    
    Late Data
    
    Performance
    
    Sizing
  - Ingest and Transform Data
    Ingest and Transform Data
    
    Import data
    
    Initial Import Overview
    
    Ingest and Transform Overview
  - Query Data
    Query Data
    
    Query Overview
    
    Purviews
    
    Scope
    
    Routing
    
    Queueing, Retries and Timeout
  - User-Defined Analytics
  - Entitlements
  - KDB-X Workloads
  - KDB-X Modules
  - Observe and Monitor
  - KX Academy Training Course
- How To
  How To
  - Configure kdb Insights Enterprise
    Configure kdb Insights Enterprise
    
    Install Configuration
    
    Base Configuration
    
    User Access
    
    Resources
    
    Availability
    
    Encryption
    Encryption
    
    Data in Transit
    
    Data at Rest
    
    Observability
    
    Storage
    
    RT Archival
    
    Advanced
    Advanced
    
    Database
    
    Scale Pods
    
    Stream Processor
    
    Overprovisioning
    
    Keycloak and PostgreSQL Config
    
    Manage Azure Secrets
  - Manage Users and Groups
    Manage Users and Groups
    
    Authentication
    
    Manage Groups
    
    Manage Service Accounts
    
    Manage Users
    
    Password Policy Text
    
    Shared Keycloak Instance
    
    Embedding in an iFrame
  - Manage Entitlements
    Manage Entitlements
    
    Prerequisites
    
    Configure
    
    Package Entitlements
    
    Data Entitlements
    Data Entitlements
    
    Configure Data Entitlements
    
    Data Entitlements Quickstart
    
    Row-Level Entitlements
    Row-Level Entitlements
    
    Configure Row-Level Entitlements
    
    Row-Level Entitlements Quickstart
  - Work with Packages
    Work with Packages
    
    Configure Package
    
    Create Package
    
    Deployment Components
    
    Runtime Components
    
    Functions in a package
    
    Dependent and Patch Components
    
    Overlays and Patches
    
    Edit Components
    
    Upload Package
    
    Deploy Package
    
    Automated Package Deployment
    
    Use Package
    
    List Packages
    
    Load Packages
    
    Download Package
    
    Backup and Restore Package
    
    Teardown Package
    
    Delete Package
    
    Pack Package
    
    Convert Assembly to Package
    
    Push Wheel Files
  - Configure User-Defined Analytics
    Configure User-Defined Analytics
    
    Configuration
    
    Quickstart
    
    Testing a UDA
    
    UDA Examples
    
    Best Practices
    
    Advanced
  - Store Data
    Store Data
    
    Configure Databases with CLI
    Configure Databases with CLI
    
    Routing Configuration
    
    Package
    Package
    
    Configure Database
    
    Configure Schema
    
    Configure Storage
    
    Configure Routing
    
    Configure Query
    
    Configure Stream
    
    Package Shared Objects
    
    Aggregation
    
    Persist to Object Storage
    
    Manual EOD Trigger
    
    Delete Rows
    
    Event Hooks
  - Ingest and Transform Data
    Ingest and Transform Data
    
    Ingest and Transform Overview
    
    Initial Import
    Initial Import
    
    Prerequisites
    
    Initial Import Quickstart
    
    Initial Import Process
    
    Batch Ingest
    
    Secure Pipelines with Kubernetes Secrets
  - Query Data
    Query Data
    
    Query Methods
    Query Methods
    
    Overview
    
    REST and QIPC
    
    Query IPC Externally
    
    SQL Query Support
    
    Query using the CLI
    Query using the CLI
    
    SQL
    
    UDAs
    
    Java Interface Query API
    
    Power BI Connector
    
    Late Data Queries
    
    Reference Data
    
    Query Scaling
    
    Query Resilience
    
    Logging
  - Visualize Data
  - Develop with KDB-X Workloads
  - Develop with KDB-X Modules
  - Integrations
    Integrations
    
    Microsoft Entra ID
    Microsoft Entra ID
    
    Entra Integration
    
    Composite Roles
    
    Power BI Connector
  - Observe and Monitor
    Observe and Monitor
    
    Logging
    
    Retrieve Logs
    
    Database Monitoring Metrics
    
    Deploy Prometheus
    
    Monitoring Stack
    Monitoring Stack
    
    Deploy using CLI
    
    Package Manager Journaling
  - Backup and Restore
    Backup and Restore
    
    KXI Deployment
    
    Keycloak Data
    
    Database
- Examples
  Examples
  - Walkthroughs and Examples Index
  - Databases
    Databases
    
    Create a Database
    
    Create Schema Script
    
    Load Multiple Packages into a DAP
  - Ingest Data
    Ingest Data
    
    Using the Web Interface
    Using the Web Interface
    
    Ingest Object Storage Data
    
    Stream Data from Kafka
    
    Streaming Kafka Ingest
    
    Ingest SQL Data
    
    Ingest Protocol Buffers Data
    
    Ingest Data from Parquet Files
    
    Using the CLI
    Using the CLI
    
    Use Cases
    
    Kafka Ingest
    Kafka Ingest
    
    Getting started
    
    Setup Kafka
    
    Basic ingestion
    
    Setup Kafka TLS
    
    Ingestion with TLS
    
    Machine Learning Clustering
    
    Amazon S3 Ingest
    Amazon S3 Ingest
    
    Batch S3 Ingest
    
    Batch S3 Ingest and Preprocessing
    
    PostgreSQL Ingest
  - Query Ingested Data
  - View Data
    View Data
    
    View Ingested Data
    
    Add a Map to a View
    
    Visualize Streaming Data
  - Python Package Walkthrough
  - Industry Examples
    Industry Examples
    
    Finance - Develop Trading Strategies
    
    Finance - Realtime ML Stock Prediction
    
    Manufacturing - Realtime ML Stock Prediction
  - Use Language Interfaces
- Reference
  Reference
  - Packaging
    Packaging
    
    Object Model
    Object Model
    
    Package
    Package
    
    Package
    
    DataFile
    
    Database
    
    PackageDependency
    
    DeploymentConfig
    
    Manifest
    
    Metadata
    
    PatchRef
    
    Pipeline
    
    Router
    
    TableList
    
    UDFCollection
    
    View
    
    Supporting Objects
    Supporting Objects
    
    Affinity
    
    Agg
    
    Algorithm
    
    Annotations
    
    AppArmorProfile
    
    AttrDisk
    
    Auth
    
    Base
    
    Bus
    
    Capabilities
    
    Claim
    
    ClusterMode
    
    Column
    
    ComponentMetadata
    
    Compression
    
    ConfigMap
    
    ConfigMapKeyRef
    
    Controller
    
    Dap
    
    DbSettings
    
    Dbm
    
    Divisor1
    
    Encryption
    
    EnvItem
    
    EodPeachLevel
    
    FieldRef
    
    FileKeyRef
    
    FileMode
    
    FormatMode
    
    GwEndpoint
    
    Image
    
    ImagePullSecret
    
    ImagePullSecret1
    
    Instances
    
    Inventory
    
    K8sPolicy
    
    LabelSelector
    
    LicType
    
    License
    
    Limits1
    
    MatchExpression
    
    Metrics
    
    Mode
    
    MountListItem
    
    Mounts
    
    NodeAffinity
    
    Partition
    
    PctMemThreshold1
    
    PctMemThreshold3
    
    Persistence
    
    PodAffinity
    
    PodAffinityTerm
    
    PodAntiAffinityPreset
    
    PodSecurityContext
    
    Preference
    
    PreferredDuringSchedulingIgnoredDuringExecutionItem
    
    PreferredDuringSchedulingIgnoredDuringExecutionItem1
    
    PrimaryKey
    
    Protocol
    
    Qlog
    
    QueryEnvironment
    
    Rc
    
    RecordCounting
    
    ReplicaAffinityTopologyKey
    
    RequiredDuringSchedulingIgnoredDuringExecution
    
    ResourceFieldRef
    
    Resources
    
    Resources1
    
    Retain
    
    RtLogVolume
    
    ScaledInstances
    
    Schedule
    
    SeLinuxOptions
    
    SecurityContext
    
    Sequencer
    
    ServiceAccountConfigure
    
    Shard
    
    SideCarConfig
    
    SideCarOverrides
    
    Size
    
    Size1
    
    Sm
    
    SubPaths
    
    Sysctl
    
    Table
    
    TableLoad
    
    Tier
    
    Toleration
    
    TopicConfig
    
    Type
    
    Type1
    
    Type2
    
    Type3
    
    UDA
    
    UDAParam
    
    UDF
    
    User
    
    ValueFrom
    
    Volume
    
    Volume1
    
    Volume2
    
    VolumeMount
    
    WindowsOptions
    
    Worker
  - Databases
    Databases
    
    Event Hooks
  - Workloads
    Workloads
    
    KDB-X Workload Yaml
  - Observability and Monitoring
    Observability and Monitoring
    
    Alerts Reference
    
    Metrics Reference
    
    Grafana Reference
  - CLI Reference
  - Configuration
  - Glossary
- Releases
  Releases
  - kdb Insights Enterprise
    kdb Insights Enterprise
    
    Latest
    
    Previous
  - Beta Features Terms
  - Azure Marketplace
  - Upgrading
    Upgrading
    
    kdb Insights Enterprise
    
    Azure
    
    F5 Ingress Controller
- Help and Support
  Help and Support
  - Product Support
  - Azure License Billing
    Azure License Billing
    
    Private Offers
    
    Billing FAQ
  - Troubleshooting
    Troubleshooting
    
    Diagnostics
    
    Deploying with IaC
    
    Data Import
    
    Reliable Transport
    
    Database and Pipeline Health
    
    Pipelines
    
    Databases
    
    User-Defined Analytics
APIs
APIs
- Overview
- OpenAPI Specs
  OpenAPI Specs
  - kdb Insights Enterprise
  - Standalone Services
    Standalone Services
    
    Overview
    
    Service Gateway
    
    Resource Coordinator
    
    Aggregator
    
    Data Access
    
    Storage Manager
    
    SP Coordinator
    
    SP Controller
    
    SP Worker
    
    Package Manager
    
    Reliable Transport
    Reliable Transport
    
    OpenAPI
    
    Guides
    Guides
    
    Overview
    
    Archiver log history
    
    Hard reset
    
    Latest output position
    
    RT clients
    
    Soft reset
    
    Deduplication publisher clients
- Client APIs
  Client APIs
  - QIPC Client
    QIPC Client
    
    Overview
    
    Query API
    Query API
    
    Overview
    
    Scratchpad Query APIs
    
    Get Data
    
    Get Meta v3
    
    Get Meta v2
    
    Get Meta
    
    Ping
    
    QSQL
    
    SQL2
    
    SQL2 Select Statements
    
    SQL2 Functions and Operators
    
    SQL
    
    Preview
    
    Reference
    Reference
    
    Overview
    
    Format
    
    Header
    
    Codes
  - kdb Insights Python API
    kdb Insights Python API
    
    Overview
    
    Guides
    Guides
    
    Querying
    
    Connection Parameters
    
    Code Reference
    Code Reference
    
    Authorization
    Authorization
    
    Client
    
    Entitlement Service
    
    Entitlement Types
    
    Group
    
    User
    
    Config
    
    Exceptions
    
    Observability
    
    Package Manager
    
    Publish
    Publish
    
    Client Controller
    
    Data Preprocessor
    
    DB Publisher
    
    HTTP Publisher
    
    Information Service
    
    RT Publisher
    
    Query
    
    UDA
    
    KDB-X Workloads
- Server-Side Toolkit
  Server-Side Toolkit
  - Stream Processor
    Stream Processor
    
    Overview
    
    Configuring Operators
    
    General
    
    Lifecycle
    
    Operators
    
    Readers
    
    Decoders
    
    Encoders
    
    Transform
    
    Stats
    
    State
    
    String Utilities
    
    Windows
    
    Writers
    
    User-Defined Functions
    
    Object Reference
    Object Reference
    
    q
    
    Python
    
    Machine Learning
  - Package Loading
    Package Loading
    
    Overview
    
    Quickstart
    
    Reference
    Reference
    
    .kxi.packages
    
    .kxi.install
    
    .kxi.udfs
  - Python UDA toolkit
    Python UDA toolkit
    
    Overview
    
    Code Reference
    Code Reference
    
    Imports
    
    Select
    
    Types
    
    UDA
  - User-Defined Analytics
    User-Defined Analytics
    
    Overview
    
    Helper functions
    
    Metadata
    
    Register
    
    Publish
- Recipes
  Recipes
  - Publishing & Subscribing
    Publishing & Subscribing
    
    Quickstart
    
    Publish API
    
    Subscribe API
  - WebSocket Streaming
    WebSocket Streaming
    
    Quickstart
    
    Protocol Reference
- Libraries
  Libraries
  - Machine Learning
    Machine Learning
    
    About
    
    q Interface
    q Interface
    
    About
    
    Analytics
    Analytics
    
    About
    
    ML Analytics API
    ML Analytics API
    
    Introduction
    
    ML Toolkit
    
    Online Models
    Online Models
    
    Introduction
    
    Stochastic Gradient Descent
    Stochastic Gradient Descent
    
    Stochastic Gradient Descent
    
    Linear Regression
    
    Logistic Classification
    
    Secure Updates
    
    Sequential K Means
    
    Variadic Functionality
    Variadic Functionality
    
    Introduction
    
    Function Calls
    
    Clustering models
    
    Statistical models
    
    Time series models
    
    Online models
    
    Registry
    Registry
    
    About
    
    Cloud Integration
    
    Registry API
    Registry API
    
    Storing
    
    Loading
    
    Deleting
    
    Examples
    Examples
    
    Basic Examples
    
    Python Interface
    Python Interface
    
    About
    
    Registry
    Registry
    
    About
    
    Cloud Integration
    
    Registry API
    Registry API
    
    Storing
    
    Loading
    
    Deleting
    
    Examples
    Examples
    
    Basic Python Examples
  - OpenAPI Client Generation
    OpenAPI Client Generation
    
    Introduction
    
    q client generation
Licensing
Licensing
Product Support
Product Support
- Product Support
- Product Lifecycle

Data Access OpenAPI¶

Previous Aggregator

Next Storage Manager

©2026 KX. All Rights Reserved. KX® and kdb+ are registered trademarks of KX Systems, Inc., a subsidiary of KX Software Limited.

Made with Material for MkDocs Insiders