| <!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Scan queries · Apache Druid</title><meta name="viewport" content="width=device-width"/><link rel="canonical" href="https://druid.apache.org/docs/latest/querying/scan-query.html"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:language" content="en"/><meta name="docsearch:version" content="0.20.0" /><meta property="og:title" content="Scan queries · Apache Druid"/><meta property="og:type" content="website"/><meta property="og:url" content="https://druid.apache.org/index.html"/><meta property="og:description" content="<!--"/><meta property="og:image" content="https://druid.apache.org/img/druid_nav.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://druid.apache.org/img/druid_nav.png"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script async="" src="https://www.googletagmanager.com/gtag/js?id=UA-131010415-1"></script><script> |
| window.dataLayer = window.dataLayer || []; |
| function gtag(){dataLayer.push(arguments); } |
| gtag('js', new Date()); |
| gtag('config', 'UA-131010415-1'); |
| </script><link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css"/><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/druid_nav.png" alt="Apache Druid"/></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/technology" target="_self">Technology</a></li><li class=""><a href="/use-cases" target="_self">Use Cases</a></li><li class=""><a href="/druid-powered" target="_self">Powered By</a></li><li class="siteNavGroupActive"><a href="/docs/latest/design/index.html" target="_self">Docs</a></li><li class=""><a href="/community/" target="_self">Community</a></li><li class=""><a href="https://www.apache.org" target="_self">Apache</a></li><li class=""><a href="/downloads.html" target="_self">Download</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Native query types</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Getting started<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/design/index.html">Introduction to Apache Druid</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/index.html">Quickstart</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/docker.html">Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/single-server.html">Single server deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/cluster.html">Clustered deployment</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Tutorials<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-batch.html">Loading files natively</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-kafka.html">Load from Apache Kafka</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-batch-hadoop.html">Load from Apache Hadoop</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-query.html">Querying data</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-rollup.html">Roll-up</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-retention.html">Configuring data retention</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-update-data.html">Updating existing data</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-compaction.html">Compacting segments</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-delete-data.html">Deleting data</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-ingestion-spec.html">Writing an ingestion spec</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-transform-spec.html">Transforming input data</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/tutorials/tutorial-kerberos-hadoop.html">Kerberized HDFS deep storage</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Design<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/design/architecture.html">Design</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/segments.html">Segments</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/processes.html">Processes and servers</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/dependencies/deep-storage.html">Deep storage</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/dependencies/metadata-storage.html">Metadata storage</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/dependencies/zookeeper.html">ZooKeeper</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Ingestion<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/index.html">Ingestion</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/data-formats.html">Data formats</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/schema-design.html">Schema design tips</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/data-management.html">Data management</a></li><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">Stream ingestion</h4><ul><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/kafka-ingestion.html">Apache Kafka</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/kinesis-ingestion.html">Amazon Kinesis</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/tranquility.html">Tranquility</a></li></ul></div><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">Batch ingestion</h4><ul><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/native-batch.html">Native batch</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/hadoop.html">Hadoop-based</a></li></ul></div><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/tasks.html">Task reference</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/faq.html">Troubleshooting FAQ</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Querying<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/querying/sql.html">Druid SQL</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/querying.html">Native queries</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/query-execution.html">Query execution</a></li><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">Concepts</h4><ul><li class="navListItem"><a class="navItem" href="/docs/latest/querying/datasource.html">Datasources</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/joins.html">Joins</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/lookups.html">Lookups</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/multi-value-dimensions.html">Multi-value dimensions</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/multitenancy.html">Multitenancy</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/caching.html">Query caching</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/query-context.html">Context parameters</a></li></ul></div><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">Native query types</h4><ul><li class="navListItem"><a class="navItem" href="/docs/latest/querying/timeseriesquery.html">Timeseries</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/topnquery.html">TopN</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/groupbyquery.html">GroupBy</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/latest/querying/scan-query.html">Scan</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/searchquery.html">Search</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/timeboundaryquery.html">TimeBoundary</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/segmentmetadataquery.html">SegmentMetadata</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/datasourcemetadataquery.html">DatasourceMetadata</a></li></ul></div><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">Native query components</h4><ul><li class="navListItem"><a class="navItem" href="/docs/latest/querying/filters.html">Filters</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/granularities.html">Granularities</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/dimensionspecs.html">Dimensions</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/aggregations.html">Aggregations</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/post-aggregations.html">Post-aggregations</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/misc/math-expr.html">Expressions</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/having.html">Having filters (groupBy)</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/limitspec.html">Sorting and limiting (groupBy)</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/topnmetricspec.html">Sorting (topN)</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/sorting-orders.html">String comparators</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/virtual-columns.html">Virtual columns</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/geo.html">Spatial filters</a></li></ul></div></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Configuration<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/configuration/index.html">Configuration reference</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions.html">Extensions</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/configuration/logging.html">Logging</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Operations<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/operations/druid-console.html">Web console</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/getting-started.html">Getting started with Apache Druid</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/basic-cluster-tuning.html">Basic cluster tuning</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/api-reference.html">API reference</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/high-availability.html">High availability</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/rolling-updates.html">Rolling updates</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/rule-configuration.html">Retaining or automatically dropping data</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/metrics.html">Metrics</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/alerts.html">Alerts</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/other-hadoop.html">Working with different versions of Apache Hadoop</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/http-compression.html">HTTP compression</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/tls-support.html">TLS support</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/password-provider.html">Password providers</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/dump-segment.html">dump-segment tool</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/reset-cluster.html">reset-cluster tool</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/insert-segment-to-db.html">insert-segment-to-db tool</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/pull-deps.html">pull-deps tool</a></li><div class="navGroup subNavGroup"><h4 class="navGroupSubcategoryTitle">Misc</h4><ul><li class="navListItem"><a class="navItem" href="/docs/latest/operations/management-uis.html">Legacy Management UIs</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/deep-storage-migration.html">Deep storage migration</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/export-metadata.html">Export Metadata Tool</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/metadata-migration.html">Metadata Migration</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/segment-optimization.html">Segment Size Optimization</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/operations/use_sbt_to_build_fat_jar.html">Content for build.sbt</a></li></ul></div></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Development<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/development/overview.html">Developing on Druid</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/modules.html">Creating extensions</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/javascript.html">JavaScript functionality</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/build.html">Build from source</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/versioning.html">Versioning</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/experimental.html">Experimental features</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Misc<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/misc/papers-and-talks.html">Papers</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Hidden<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/latest/comparisons/druid-vs-elasticsearch.html">Apache Druid vs Elasticsearch</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/comparisons/druid-vs-key-value.html">Apache Druid vs. Key/Value Stores (HBase/Cassandra/OpenTSDB)</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/comparisons/druid-vs-kudu.html">Apache Druid vs Kudu</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/comparisons/druid-vs-redshift.html">Apache Druid vs Redshift</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/comparisons/druid-vs-spark.html">Apache Druid vs Spark</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/comparisons/druid-vs-sql-on-hadoop.html">Apache Druid vs SQL-on-Hadoop</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/auth.html">Authentication and Authorization</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/broker.html">Broker</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/coordinator.html">Coordinator Process</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/historical.html">Historical Process</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/indexer.html">Indexer Process</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/indexing-service.html">Indexing Service</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/middlemanager.html">MiddleManager Process</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/overlord.html">Overlord Process</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/router.html">Router Process</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/design/peons.html">Peons</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/approximate-histograms.html">Approximate Histogram aggregators</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/avro.html">Apache Avro</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/azure.html">Microsoft Azure</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/bloom-filter.html">Bloom Filter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/datasketches-extension.html">DataSketches extension</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/datasketches-hll.html">DataSketches HLL Sketch module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/datasketches-quantiles.html">DataSketches Quantiles Sketch module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/datasketches-theta.html">DataSketches Theta Sketch module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/datasketches-tuple.html">DataSketches Tuple Sketch module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/druid-basic-security.html">Basic Security</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/druid-kerberos.html">Kerberos</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/druid-lookups.html">Cached Lookup Module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/druid-ranger-security.html">Apache Ranger Security</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/google.html">Google Cloud Storage</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/hdfs.html">HDFS</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/kafka-extraction-namespace.html">Apache Kafka Lookups</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/lookups-cached-global.html">Globally Cached Lookups</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/mysql.html">MySQL Metadata Store</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/orc.html">ORC Extension</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/druid-pac4j.html">Druid pac4j based Security extension</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/parquet.html">Apache Parquet Extension</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/postgresql.html">PostgreSQL Metadata Store</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/protobuf.html">Protobuf</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/s3.html">S3-compatible</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/simple-client-sslcontext.html">Simple SSLContext Provider Module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/stats.html">Stats aggregator</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-core/test-stats.html">Test Stats Aggregators</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/ambari-metrics-emitter.html">Ambari Metrics Emitter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/cassandra.html">Apache Cassandra</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/cloudfiles.html">Rackspace Cloud Files</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/distinctcount.html">DistinctCount Aggregator</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/graphite.html">Graphite Emitter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/influx.html">InfluxDB Line Protocol Parser</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/influxdb-emitter.html">InfluxDB Emitter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/kafka-emitter.html">Kafka Emitter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/materialized-view.html">Materialized View</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/momentsketch-quantiles.html">Moment Sketches for Approximate Quantiles module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/moving-average-query.html">Moving Average Query</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/opentsdb-emitter.html">OpenTSDB Emitter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/redis-cache.html">Druid Redis Cache</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/sqlserver.html">Microsoft SQLServer</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/statsd.html">StatsD Emitter</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/tdigestsketch-quantiles.html">T-Digest Quantiles Sketch module</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/thrift.html">Thrift</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/time-min-max.html">Timestamp Min/Max aggregators</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/gce-extensions.html">GCE Extensions</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/development/extensions-contrib/aliyun-oss.html">Aliyun OSS</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/hll-old.html">Cardinality/HyperUnique aggregators</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/querying/select-query.html">Select</a></li><li class="navListItem"><a class="navItem" href="/docs/latest/ingestion/standalone-realtime.html">Realtime Process</a></li></ul></div></div></section></div><script> |
| var coll = document.getElementsByClassName('collapsible'); |
| var checkActiveCategory = true; |
| for (var i = 0; i < coll.length; i++) { |
| var links = coll[i].nextElementSibling.getElementsByTagName('*'); |
| if (checkActiveCategory){ |
| for (var j = 0; j < links.length; j++) { |
| if (links[j].classList.contains('navListItemActive')){ |
| coll[i].nextElementSibling.classList.toggle('hide'); |
| coll[i].childNodes[1].classList.toggle('rotate'); |
| checkActiveCategory = false; |
| break; |
| } |
| } |
| } |
| |
| coll[i].addEventListener('click', function() { |
| var arrow = this.childNodes[1]; |
| arrow.classList.toggle('rotate'); |
| var content = this.nextElementSibling; |
| content.classList.toggle('hide'); |
| }); |
| } |
| |
| document.addEventListener('DOMContentLoaded', function() { |
| createToggler('#navToggler', '#docsNav', 'docsSliderActive'); |
| createToggler('#tocToggler', 'body', 'tocActive'); |
| |
| var headings = document.querySelector('.toc-headings'); |
| headings && headings.addEventListener('click', function(event) { |
| var el = event.target; |
| while(el !== headings){ |
| if (el.tagName === 'A') { |
| document.body.classList.remove('tocActive'); |
| break; |
| } else{ |
| el = el.parentNode; |
| } |
| } |
| }, false); |
| |
| function createToggler(togglerSelector, targetSelector, className) { |
| var toggler = document.querySelector(togglerSelector); |
| var target = document.querySelector(targetSelector); |
| |
| if (!toggler) { |
| return; |
| } |
| |
| toggler.onclick = function(event) { |
| event.preventDefault(); |
| |
| target.classList.toggle(className); |
| }; |
| } |
| }); |
| </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/apache/druid/edit/master/docs/querying/scan-query.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Scan queries</h1></header><article><div><span><!-- |
| ~ Licensed to the Apache Software Foundation (ASF) under one |
| ~ or more contributor license agreements. See the NOTICE file |
| ~ distributed with this work for additional information |
| ~ regarding copyright ownership. The ASF licenses this file |
| ~ to you under the Apache License, Version 2.0 (the |
| ~ "License"); you may not use this file except in compliance |
| ~ with the License. You may obtain a copy of the License at |
| ~ |
| ~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~ |
| ~ Unless required by applicable law or agreed to in writing, |
| ~ software distributed under the License is distributed on an |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~ KIND, either express or implied. See the License for the |
| ~ specific language governing permissions and limitations |
| ~ under the License. |
| --> |
| <blockquote> |
| <p>Apache Druid supports two query languages: <a href="/docs/latest/querying/sql.html">Druid SQL</a> and <a href="/docs/latest/querying/querying.html">native queries</a>. |
| This document describes a query |
| type in the native language. For information about when Druid SQL will use this query type, refer to the |
| <a href="/docs/latest/querying/sql.html#query-types">SQL documentation</a>.</p> |
| </blockquote> |
| <p>The Scan query returns raw Apache Druid rows in streaming mode.</p> |
| <p>In addition to straightforward usage where a Scan query is issued to the Broker, the Scan query can also be issued |
| directly to Historical processes or streaming ingestion tasks. This can be useful if you want to retrieve large |
| amounts of data in parallel.</p> |
| <p>An example Scan query object is shown below:</p> |
| <pre><code class="hljs css language-json"> { |
| <span class="hljs-attr">"queryType"</span>: <span class="hljs-string">"scan"</span>, |
| <span class="hljs-attr">"dataSource"</span>: <span class="hljs-string">"wikipedia"</span>, |
| <span class="hljs-attr">"resultFormat"</span>: <span class="hljs-string">"list"</span>, |
| <span class="hljs-attr">"columns"</span>:[], |
| <span class="hljs-attr">"intervals"</span>: [ |
| <span class="hljs-string">"2013-01-01/2013-01-02"</span> |
| ], |
| <span class="hljs-attr">"batchSize"</span>:<span class="hljs-number">20480</span>, |
| <span class="hljs-attr">"limit"</span>:<span class="hljs-number">3</span> |
| } |
| </code></pre> |
| <p>The following are the main parameters for Scan queries:</p> |
| <table> |
| <thead> |
| <tr><th>property</th><th>description</th><th>required?</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>queryType</td><td>This String should always be "scan"; this is the first thing Druid looks at to figure out how to interpret the query</td><td>yes</td></tr> |
| <tr><td>dataSource</td><td>A String or Object defining the data source to query, very similar to a table in a relational database. See <a href="/docs/latest/querying/datasource.html">DataSource</a> for more information.</td><td>yes</td></tr> |
| <tr><td>intervals</td><td>A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.</td><td>yes</td></tr> |
| <tr><td>resultFormat</td><td>How the results are represented: list, compactedList or valueVector. Currently only <code>list</code> and <code>compactedList</code> are supported. Default is <code>list</code></td><td>no</td></tr> |
| <tr><td>filter</td><td>See <a href="/docs/latest/querying/filters.html">Filters</a></td><td>no</td></tr> |
| <tr><td>columns</td><td>A String array of dimensions and metrics to scan. If left empty, all dimensions and metrics are returned.</td><td>no</td></tr> |
| <tr><td>batchSize</td><td>The maximum number of rows buffered before being returned to the client. Default is <code>20480</code></td><td>no</td></tr> |
| <tr><td>limit</td><td>How many rows to return. If not specified, all rows will be returned.</td><td>no</td></tr> |
| <tr><td>offset</td><td>Skip this many rows when returning results. Skipped rows will still need to be generated internally and then discarded, meaning that raising offsets to high values can cause queries to use additional resources.<br /><br />Together, "limit" and "offset" can be used to implement pagination. However, note that if the underlying datasource is modified in between page fetches in ways that affect overall query results, then the different pages will not necessarily align with each other.</td><td>no</td></tr> |
| <tr><td>order</td><td>The ordering of returned rows based on timestamp. "ascending", "descending", and "none" (default) are supported. Currently, "ascending" and "descending" are only supported for queries where the <code>__time</code> column is included in the <code>columns</code> field and the requirements outlined in the <a href="#time-ordering">time ordering</a> section are met.</td><td>none</td></tr> |
| <tr><td>legacy</td><td>Return results consistent with the legacy "scan-query" contrib extension. Defaults to the value set by <code>druid.query.scan.legacy</code>, which in turn defaults to false. See <a href="#legacy-mode">Legacy mode</a> for details.</td><td>no</td></tr> |
| <tr><td>context</td><td>An additional JSON Object which can be used to specify certain flags (see the <code>query context properties</code> section below).</td><td>no</td></tr> |
| </tbody> |
| </table> |
| <h2><a class="anchor" aria-hidden="true" id="example-results"></a><a href="#example-results" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example results</h2> |
| <p>The format of the result when resultFormat equals <code>list</code>:</p> |
| <pre><code class="hljs css language-json"> [{ |
| <span class="hljs-attr">"segmentId"</span> : <span class="hljs-string">"wikipedia_editstream_2012-12-29T00:00:00.000Z_2013-01-10T08:00:00.000Z_2013-01-10T08:13:47.830Z_v9"</span>, |
| <span class="hljs-attr">"columns"</span> : [ |
| <span class="hljs-string">"timestamp"</span>, |
| <span class="hljs-string">"robot"</span>, |
| <span class="hljs-string">"namespace"</span>, |
| <span class="hljs-string">"anonymous"</span>, |
| <span class="hljs-string">"unpatrolled"</span>, |
| <span class="hljs-string">"page"</span>, |
| <span class="hljs-string">"language"</span>, |
| <span class="hljs-string">"newpage"</span>, |
| <span class="hljs-string">"user"</span>, |
| <span class="hljs-string">"count"</span>, |
| <span class="hljs-string">"added"</span>, |
| <span class="hljs-string">"delta"</span>, |
| <span class="hljs-string">"variation"</span>, |
| <span class="hljs-string">"deleted"</span> |
| ], |
| <span class="hljs-attr">"events"</span> : [ { |
| <span class="hljs-attr">"timestamp"</span> : <span class="hljs-string">"2013-01-01T00:00:00.000Z"</span>, |
| <span class="hljs-attr">"robot"</span> : <span class="hljs-string">"1"</span>, |
| <span class="hljs-attr">"namespace"</span> : <span class="hljs-string">"article"</span>, |
| <span class="hljs-attr">"anonymous"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"unpatrolled"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"page"</span> : <span class="hljs-string">"11._korpus_(NOVJ)"</span>, |
| <span class="hljs-attr">"language"</span> : <span class="hljs-string">"sl"</span>, |
| <span class="hljs-attr">"newpage"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"user"</span> : <span class="hljs-string">"EmausBot"</span>, |
| <span class="hljs-attr">"count"</span> : <span class="hljs-number">1.0</span>, |
| <span class="hljs-attr">"added"</span> : <span class="hljs-number">39.0</span>, |
| <span class="hljs-attr">"delta"</span> : <span class="hljs-number">39.0</span>, |
| <span class="hljs-attr">"variation"</span> : <span class="hljs-number">39.0</span>, |
| <span class="hljs-attr">"deleted"</span> : <span class="hljs-number">0.0</span> |
| }, { |
| <span class="hljs-attr">"timestamp"</span> : <span class="hljs-string">"2013-01-01T00:00:00.000Z"</span>, |
| <span class="hljs-attr">"robot"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"namespace"</span> : <span class="hljs-string">"article"</span>, |
| <span class="hljs-attr">"anonymous"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"unpatrolled"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"page"</span> : <span class="hljs-string">"112_U.S._580"</span>, |
| <span class="hljs-attr">"language"</span> : <span class="hljs-string">"en"</span>, |
| <span class="hljs-attr">"newpage"</span> : <span class="hljs-string">"1"</span>, |
| <span class="hljs-attr">"user"</span> : <span class="hljs-string">"MZMcBride"</span>, |
| <span class="hljs-attr">"count"</span> : <span class="hljs-number">1.0</span>, |
| <span class="hljs-attr">"added"</span> : <span class="hljs-number">70.0</span>, |
| <span class="hljs-attr">"delta"</span> : <span class="hljs-number">70.0</span>, |
| <span class="hljs-attr">"variation"</span> : <span class="hljs-number">70.0</span>, |
| <span class="hljs-attr">"deleted"</span> : <span class="hljs-number">0.0</span> |
| }, { |
| <span class="hljs-attr">"timestamp"</span> : <span class="hljs-string">"2013-01-01T00:00:00.000Z"</span>, |
| <span class="hljs-attr">"robot"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"namespace"</span> : <span class="hljs-string">"article"</span>, |
| <span class="hljs-attr">"anonymous"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"unpatrolled"</span> : <span class="hljs-string">"0"</span>, |
| <span class="hljs-attr">"page"</span> : <span class="hljs-string">"113_U.S._243"</span>, |
| <span class="hljs-attr">"language"</span> : <span class="hljs-string">"en"</span>, |
| <span class="hljs-attr">"newpage"</span> : <span class="hljs-string">"1"</span>, |
| <span class="hljs-attr">"user"</span> : <span class="hljs-string">"MZMcBride"</span>, |
| <span class="hljs-attr">"count"</span> : <span class="hljs-number">1.0</span>, |
| <span class="hljs-attr">"added"</span> : <span class="hljs-number">77.0</span>, |
| <span class="hljs-attr">"delta"</span> : <span class="hljs-number">77.0</span>, |
| <span class="hljs-attr">"variation"</span> : <span class="hljs-number">77.0</span>, |
| <span class="hljs-attr">"deleted"</span> : <span class="hljs-number">0.0</span> |
| } ] |
| } ] |
| </code></pre> |
| <p>The format of the result when resultFormat equals <code>compactedList</code>:</p> |
| <pre><code class="hljs css language-json"> [{ |
| <span class="hljs-attr">"segmentId"</span> : <span class="hljs-string">"wikipedia_editstream_2012-12-29T00:00:00.000Z_2013-01-10T08:00:00.000Z_2013-01-10T08:13:47.830Z_v9"</span>, |
| <span class="hljs-attr">"columns"</span> : [ |
| <span class="hljs-string">"timestamp"</span>, <span class="hljs-string">"robot"</span>, <span class="hljs-string">"namespace"</span>, <span class="hljs-string">"anonymous"</span>, <span class="hljs-string">"unpatrolled"</span>, <span class="hljs-string">"page"</span>, <span class="hljs-string">"language"</span>, <span class="hljs-string">"newpage"</span>, <span class="hljs-string">"user"</span>, <span class="hljs-string">"count"</span>, <span class="hljs-string">"added"</span>, <span class="hljs-string">"delta"</span>, <span class="hljs-string">"variation"</span>, <span class="hljs-string">"deleted"</span> |
| ], |
| <span class="hljs-attr">"events"</span> : [ |
| [<span class="hljs-string">"2013-01-01T00:00:00.000Z"</span>, <span class="hljs-string">"1"</span>, <span class="hljs-string">"article"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"11._korpus_(NOVJ)"</span>, <span class="hljs-string">"sl"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"EmausBot"</span>, <span class="hljs-number">1.0</span>, <span class="hljs-number">39.0</span>, <span class="hljs-number">39.0</span>, <span class="hljs-number">39.0</span>, <span class="hljs-number">0.0</span>], |
| [<span class="hljs-string">"2013-01-01T00:00:00.000Z"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"article"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"112_U.S._580"</span>, <span class="hljs-string">"en"</span>, <span class="hljs-string">"1"</span>, <span class="hljs-string">"MZMcBride"</span>, <span class="hljs-number">1.0</span>, <span class="hljs-number">70.0</span>, <span class="hljs-number">70.0</span>, <span class="hljs-number">70.0</span>, <span class="hljs-number">0.0</span>], |
| [<span class="hljs-string">"2013-01-01T00:00:00.000Z"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"article"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"0"</span>, <span class="hljs-string">"113_U.S._243"</span>, <span class="hljs-string">"en"</span>, <span class="hljs-string">"1"</span>, <span class="hljs-string">"MZMcBride"</span>, <span class="hljs-number">1.0</span>, <span class="hljs-number">77.0</span>, <span class="hljs-number">77.0</span>, <span class="hljs-number">77.0</span>, <span class="hljs-number">0.0</span>] |
| ] |
| } ] |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="time-ordering"></a><a href="#time-ordering" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Time ordering</h2> |
| <p>The Scan query currently supports ordering based on timestamp for non-legacy queries. Note that using time ordering |
| will yield results that do not indicate which segment rows are from (<code>segmentId</code> will show up as <code>null</code>). Furthermore, |
| time ordering is only supported where the result set limit is less than <code>druid.query.scan.maxRowsQueuedForOrdering</code> |
| rows <strong>or</strong> all segments scanned have fewer than <code>druid.query.scan.maxSegmentPartitionsOrderedInMemory</code> partitions. Also, |
| time ordering is not supported for queries issued directly to historicals unless a list of segments is specified. The |
| reasoning behind these limitations is that the implementation of time ordering uses two strategies that can consume too |
| much heap memory if left unbounded. These strategies (listed below) are chosen on a per-Historical basis depending on |
| query result set limit and the number of segments being scanned.</p> |
| <ol> |
| <li><p>Priority Queue: Each segment on a Historical is opened sequentially. Every row is added to a bounded priority |
| queue which is ordered by timestamp. For every row above the result set limit, the row with the earliest (if descending) |
| or latest (if ascending) timestamp will be dequeued. After every row has been processed, the sorted contents of the |
| priority queue are streamed back to the Broker(s) in batches. Attempting to load too many rows into memory runs the |
| risk of Historical nodes running out of memory. The <code>druid.query.scan.maxRowsQueuedForOrdering</code> property protects |
| from this by limiting the number of rows in the query result set when time ordering is used.</p></li> |
| <li><p>N-Way Merge: For each segment, each partition is opened in parallel. Since each partition's rows are already |
| time-ordered, an n-way merge can be performed on the results from each partition. This approach doesn't persist the entire |
| result set in memory (like the Priority Queue) as it streams back batches as they are returned from the merge function. |
| However, attempting to query too many partition could also result in high memory usage due to the need to open |
| decompression and decoding buffers for each. The <code>druid.query.scan.maxSegmentPartitionsOrderedInMemory</code> limit protects |
| from this by capping the number of partitions opened at any times when time ordering is used.</p></li> |
| </ol> |
| <p>Both <code>druid.query.scan.maxRowsQueuedForOrdering</code> and <code>druid.query.scan.maxSegmentPartitionsOrderedInMemory</code> are |
| configurable and can be tuned based on hardware specs and number of dimensions being queried. These config properties |
| can also be overridden using the <code>maxRowsQueuedForOrdering</code> and <code>maxSegmentPartitionsOrderedInMemory</code> properties in |
| the query context (see the Query Context Properties section).</p> |
| <h2><a class="anchor" aria-hidden="true" id="legacy-mode"></a><a href="#legacy-mode" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Legacy mode</h2> |
| <p>The Scan query supports a legacy mode designed for protocol compatibility with the former scan-query contrib extension. |
| In legacy mode you can expect the following behavior changes:</p> |
| <ul> |
| <li>The <code>__time</code> column is returned as <code>"timestamp"</code> rather than <code>"__time"</code>. This will take precedence over any other column |
| you may have that is named <code>"timestamp"</code>.</li> |
| <li>The <code>__time</code> column is included in the list of columns even if you do not specifically ask for it.</li> |
| <li>Timestamps are returned as ISO8601 time strings rather than integers (milliseconds since 1970-01-01 00:00:00 UTC).</li> |
| </ul> |
| <p>Legacy mode can be triggered either by passing <code>"legacy" : true</code> in your query JSON, or by setting |
| <code>druid.query.scan.legacy = true</code> on your Druid processes. If you were previously using the scan-query contrib extension, |
| the best way to migrate is to activate legacy mode during a rolling upgrade, then switch it off after the upgrade |
| is complete.</p> |
| <h2><a class="anchor" aria-hidden="true" id="configuration-properties"></a><a href="#configuration-properties" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Configuration Properties</h2> |
| <p>Configuration properties:</p> |
| <table> |
| <thead> |
| <tr><th>property</th><th>description</th><th>values</th><th>default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>druid.query.scan.maxRowsQueuedForOrdering</td><td>The maximum number of rows returned when time ordering is used</td><td>An integer in [1, 2147483647]</td><td>100000</td></tr> |
| <tr><td>druid.query.scan.maxSegmentPartitionsOrderedInMemory</td><td>The maximum number of segments scanned per historical when time ordering is used</td><td>An integer in [1, 2147483647]</td><td>50</td></tr> |
| <tr><td>druid.query.scan.legacy</td><td>Whether legacy mode should be turned on for Scan queries</td><td>true or false</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h2><a class="anchor" aria-hidden="true" id="query-context-properties"></a><a href="#query-context-properties" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Query context properties</h2> |
| <table> |
| <thead> |
| <tr><th>property</th><th>description</th><th>values</th><th>default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>maxRowsQueuedForOrdering</td><td>The maximum number of rows returned when time ordering is used. Overrides the identically named config.</td><td>An integer in [1, 2147483647]</td><td><code>druid.query.scan.maxRowsQueuedForOrdering</code></td></tr> |
| <tr><td>maxSegmentPartitionsOrderedInMemory</td><td>The maximum number of segments scanned per historical when time ordering is used. Overrides the identically named config.</td><td>An integer in [1, 2147483647]</td><td><code>druid.query.scan.maxSegmentPartitionsOrderedInMemory</code></td></tr> |
| </tbody> |
| </table> |
| <p>Sample query context JSON object:</p> |
| <pre><code class="hljs css language-json">{ |
| <span class="hljs-attr">"maxRowsQueuedForOrdering"</span>: <span class="hljs-number">100001</span>, |
| <span class="hljs-attr">"maxSegmentPartitionsOrderedInMemory"</span>: <span class="hljs-number">100</span> |
| } |
| </code></pre> |
| </span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/latest/querying/groupbyquery.html"><span class="arrow-prev">← </span><span class="function-name-prevnext">GroupBy</span></a><a class="docs-next button" href="/docs/latest/querying/searchquery.html"><span>Search</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#example-results">Example results</a></li><li><a href="#time-ordering">Time ordering</a></li><li><a href="#legacy-mode">Legacy mode</a></li><li><a href="#configuration-properties">Configuration Properties</a></li><li><a href="#query-context-properties">Query context properties</a></li></ul></nav></div><footer class="nav-footer druid-footer" id="footer"><div class="container"><div class="text-center"><p><a href="/technology">Technology</a> · <a href="/use-cases">Use Cases</a> · <a href="/druid-powered">Powered by Druid</a> · <a href="/docs/latest/latest">Docs</a> · <a href="/community/">Community</a> · <a href="/downloads.html">Download</a> · <a href="/faq">FAQ</a></p></div><div class="text-center"><a title="Join the user group" href="https://groups.google.com/forum/#!forum/druid-user" target="_blank"><span class="fa fa-comments"></span></a> · <a title="Follow Druid" href="https://twitter.com/druidio" target="_blank"><span class="fab fa-twitter"></span></a> · <a title="Download via Apache" href="https://www.apache.org/dyn/closer.cgi?path=/incubator/druid/{{ site.druid_versions[0].versions[0].version }}/apache-druid-{{ site.druid_versions[0].versions[0].version }}-bin.tar.gz" target="_blank"><span class="fas fa-feather"></span></a> · <a title="GitHub" href="https://github.com/apache/druid" target="_blank"><span class="fab fa-github"></span></a></div><div class="text-center license">Copyright © 2019 <a href="https://www.apache.org/" target="_blank">Apache Software Foundation</a>.<br/>Except where otherwise noted, licensed under <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.<br/>Apache Druid, Druid, and the Druid logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</div></div></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script> |
| document.addEventListener('keyup', function(e) { |
| if (e.target !== document.body) { |
| return; |
| } |
| // keyCode for '/' (slash) |
| if (e.keyCode === 191) { |
| const search = document.getElementById('search_input_react'); |
| search && search.focus(); |
| } |
| }); |
| </script><script> |
| var search = docsearch({ |
| |
| apiKey: '2de99082a9f38e49dfaa059bbe4c901d', |
| indexName: 'apache_druid', |
| inputSelector: '#search_input_react', |
| algoliaOptions: {"facetFilters":["language:en","version:0.20.0"]} |
| }); |
| </script></body></html> |
