Skip to content
kdb products
1.9
Package Object Reference
Initializing search
Ask a question
Home
kdb+ and q
kdb Insights
kdb Insights Enterprise
KDB.AI
PyKX
APIs
Licensing
Accelerators
Help
kdb products
Home
kdb+ and q
kdb Insights
kdb Insights
About
Free Trial
Prerequisites
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
Labelling
Logging
Logging
About
Quickstart
API reference
Release notes
Release notes
Latest
Previous
Database
Database
Overview
Data configuration
Data configuration
Overview
Routing
Assembly
Assembly
Database
Schema
Storage
Query
Stream
Aggregation
Advanced
Advanced
Overview
Query scaling
Authorization
Authorization
Custom IPC Authorization
Custom HTTP Authorization
Data storage
Data storage
Overview
Storage tiering
Initial import
Batch ingest
Delete
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
REST vs QIPC
SQL
Custom APIs
Monitoring
Best practices
Best practices
Late Data
Performance
Deploying
Deploying
Overview
Docker
Docker
Basic
Metrics
Kubernetes
Kubernetes
Service Gateway
Upgrading
Downgrading
Glossary
Stream Processor
Stream Processor
About Streaming Data
Quickstart
Quickstart
Docker
Kubernetes
Writing
Running
Configuration
Examples
Examples
Static file
Batch S3 ingestion
Streaming Kafka ingestion
Kafka 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
State
Reliable Transport
Reliable Transport
About
Quickstart
Quickstart
About
Docker
Kubernetes
Publishers
Publishers
Overview
RT Bridge
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)
Examples
Examples
Publishing to Enterprise using q
Recovering archived logs
Configuration
Configuration
Overview
Diagnostics
Monitoring
Administration
Administration
Soft reset
Hard reset
Release notes
Release notes
Latest
Previous
Extras
Extras
Tutorials
Tutorials
Streaming to a web-socket client
Machine Learning
Machine Learning
About
Quickstart
Quickstart
Docker
Kubernetes
Examples
Examples
Model Generation & Deployment
kdb Insights Enterprise
kdb Insights Enterprise
Home
About
Architecture
Install
Install
Overview
Free Trial
Free Trial
Overview
Product tour
Azure Marketplace
Azure Marketplace
Offers
KX Managed
KX Managed
About
Installing
Installing
Prerequisites
Prerequisites
Prerequisites
Permissions
User Node Pool Sizing
Install
Login
Potential issues
Billing
Billing
About
FAQ
Security
Licensing
Release Notes
Release Notes
Latest
Previous
License only
Private offers
Azure Integrations
Azure Integrations
Azure Data Factory
Azure Active Directory
Azure Active Directory
Azure Active Directory
AAD Keycloak Composite Roles
Azure Monitoring
Azure Monitoring
Alert Configuration
Workbook Configuration
Azure PowerBI
Support
Support
KX Support
Azure Secrets
Standalone
Standalone
Infrastructure
Infrastructure
Managed K8S
Managed K8S
Prerequisites
Terraform
Terraform
Deployment
Deployment
Overview
Cloud provider
Cloud provider
GCP
AWS
Azure
Interacting with Kubernetes
DNS setup
On-Prem OpenShift
On-Prem OpenShift
Prerequisites
Installation
Installation
Installing
Upgrading
Air-gapped environments
Use
Use
Get started
Get started
Overview
User Interface
User Interface
Log in
UI Overview
System Information
Guided walkthroughs
Guided walkthroughs
Index
Ingest and Query
Ingest and Query
Database
Object Storage
Kafka
SQL Database
Protocol Buffer
Query
Visualize
Visualize
Build a View
Maps
Streaming
Diagnostics
Industry tutorials
Industry tutorials
Index
Finance
Finance
Backtest trading strategies
Run ML model in real-time
Kafka
Manufacturing
Parquet
Configuring a database
Configuring a database
Overview
Configuration options
Configuration options
Overview
Routing
User interface
User interface
Database Admin
Database Settings
Schema Settings
Stream Settings
Database Resources
Assembly
Assembly
Database
Schema
Storage
Routing
Query
Stream
Reference
Aggregation
Advanced
Advanced
Overview
Query scaling
Deploying
Monitoring
Best practices
Best practices
Late data
Performance
Upgrading
Glossary
Storing Data
Storing Data
Overview
Storage tiering
Object storage
Initial import
Batch ingest
Ingest & transform
Ingest & transform
Overview
Import wizard
Pipelines
Pipelines
Overview
Test
Deploy
Operators
Operators
Overview
Readers
Writers
Functions
Decoders
Encoders
Transform
Stats
Windows
Machine Learning
String Utilities
Troubleshooting
Examples
Examples
Overview
Kafka
Kafka
Getting started
Setup Kafka
Basic ingestion
Setup Kafka TLS
Enabling TLS ingestion
Fitting Machine Learning model on Kafka data
PostgreSQL query
PostgreSQL query
Getting started
Setup PostgreSQL
Querying PostgreSQL
S3
S3
Batch S3 ingest
Fitting Machine Learning model on S3 data
Using language interfaces
Querying data
Querying data
Overview
Purviews
Scope
Late data
Reference data
Routing
Queueing, retries and timeouts
Query methods
Query methods
UI
REST vs QIPC
SQL
Custom APIs
Java interface
Resilience
Logging
Troubleshooting
Packaging
Packaging
Introduction
Quickstart
Components
Command line interface
Package Lifecycle
Package Lifecycle
Creating a Package
Editing a package
Uploading a package
Deploying a package
Using a package
Code and Dependencies
Code and Dependencies
Entrypoints
UDFs
Dependencies
Overlays & Patches
Using package code locally
Package Object Reference
Analysing your data
Analysing your data
Overview
Using the UI Query window
Using the UI Query window
Querying databases
Developing using q
Developing using Python
Visualizing Data
Visualizing Data
Views Overview
Quickstart guide to Views
Guide to building Views
Diagnostics
Diagnostics
Diagnosing deployments
Administer
Administer
Command line interface
Command line interface
Overview
Installing the CLI
Configuration
Authentication
Backup and Restore
Reference
Assembly Deployment
Assembly Deployment
Overview
Building
Deploying
Upgrading
Data Entitlements
Data Entitlements
Overview
Prerequisites
Quickstart
Configuration
Security and authentication
Security and authentication
User Authentication and authorization
User Authentication and authorization
Overview
Managing groups
Managing service accounts
Managing users
Data Encryption in Transit
Shared Keycloak instance
Keycloak backup and restore
Configuration
Configuration
Overview
Setup
Security
Resources
Availability
Observability
Storage
Database
RT archival
Stream Processor
Advanced
Advanced
Password policy
Overprovisioning
Observability
Observability
Overview
Logging
Monitoring
Monitoring
Overview
Metrics reference
Alerts reference
Dashboard reference
Develop
Develop
REST API
Packaging
Stream Processor
Machine Learning
Language interfaces
Language interfaces
Overview
RT Bridge
Extensions
Extensions
Visual Studio Code Extension
Glossary
Release notes
Release notes
Latest
Previous
Beta features
KDB.AI
PyKX
APIs
APIs
Overview
OpenAPI
OpenAPI
Introduction
q client generation
Packages
Packages
Overview
q Interface
q Interface
Overview
Packages
User-Defined Functions
Python Interface
Python Interface
Overview
Packages
User Defined Functions
Open API
Database
Database
Overview
Interface
Interface
Overview
Header
Codes
Query
Query
Overview
Get Data
Get Meta
Ping
QSQL
SQL
SQL2
SQL2
SQL2
SQL2 Select Statements
SQL2 Functions and Operators
Preview
Custom APIs
Custom APIs
Overview
Metadata
Publish
Registration
Helper Functions
OpenAPI
OpenAPI
Overview
Service Gateway
Resource Coordinator
Aggregator
Data Access
Storage Manager
Reliable Transport
Reliable Transport
Overview
APIs
APIs
Archiver log history
Hard reset
Latest output position
RT clients
Soft reset
OpenAPI
OpenAPI
Worker
Stream Processor
Stream Processor
Overview
q Interface
q Interface
Overview
Configuring Operators
General
Lifecycle
Operators
Data Structures
Readers
Decoders
Encoders
Data Transforms
Stats
State
String
Windows
Writers
User-Defined Functions
Machine Learning
Python Interface
Python Interface
Overview
General
Lifecycle
Operators
Readers
Decoders
Encoders
Data Transforms
Stats
State
String
Windows
Writers
Machine Learning
OpenAPI
OpenAPI
Coordinator
Controller
Worker
Streaming
Streaming
Web-sockets
Web-sockets
Client protocol
kdb Insights Python API
kdb Insights Python API
Overview
Quickstart
Query API
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
Licensing
Licensing
KX Licensing Overview
Installing Licenses
RAM Capacity Reporting
Accelerators
Accelerators
kdb Accelerators
Overview
Accelerators
Accelerators
ICE Order Book
ICE Order Book
ICE Overview
ICE Order Book Quickstart Guide
Ingestion
Order Book Data
Release Notes
FSI Library
FSI Library
FSI Overview
APIs
APIs
getTicks
getStats
getStats
Overview
Customize getStats
getBars
getBars
Overview
Customize getBars data
Asset specific functionality
Asset specific functionality
Overview
Futures
FX
Cancellations & Corrections
API configuration
Error & Exceptions Glossary
Release Notes
Getting Started
Deployment
Deployment
Setup
Customize
Configuration
Deploy
Pipeline Administration
Using an Accelerator
Ingesting Data
Ingesting Data
Ingesting Data
Help
Package objects
Below is a comprehensive list of objects that are used in the packaging ecosystem.