Search Shortcut cmd + k | ctrl + k
- Installation
- Documentation
- Getting Started
- Connect
- Data Import
- Overview
- Data Sources
- CSV Files
- JSON Files
- Overview
- Creating JSON
- Loading JSON
- Writing JSON
- JSON Type
- JSON Functions
- Format Settings
- Installing and Loading
- SQL to / from JSON
- Caveats
- Multiple Files
- Parquet Files
- Partitioning
- Appender
- INSERT Statements
- Client APIs
- Overview
- C
- Overview
- Startup
- Configuration
- Query
- Data Chunks
- Vectors
- Values
- Types
- Prepared Statements
- Appender
- Table Functions
- Replacement Scans
- API Reference
- C++
- CLI
- Dart
- Go
- Java
- Julia
- Node.js (Neo)
- Node.js
- Python
- Overview
- Data Ingestion
- Conversion between DuckDB and Python
- DB API
- Relational API
- Function API
- Types API
- Expression API
- Spark API
- API Reference
- Known Python Issues
- R
- Rust
- Swift
- Wasm
- ADBC
- ODBC
- SQL
- Introduction
- Statements
- Overview
- ANALYZE
- ALTER TABLE
- ALTER VIEW
- ATTACH and DETACH
- CALL
- CHECKPOINT
- COMMENT ON
- COPY
- CREATE INDEX
- CREATE MACRO
- CREATE SCHEMA
- CREATE SECRET
- CREATE SEQUENCE
- CREATE TABLE
- CREATE VIEW
- CREATE TYPE
- DELETE
- DESCRIBE
- DROP
- EXPORT and IMPORT DATABASE
- INSERT
- PIVOT
- Profiling
- SELECT
- SET / RESET
- SET VARIABLE
- SUMMARIZE
- Transaction Management
- UNPIVOT
- UPDATE
- USE
- VACUUM
- LOAD / INSTALL
- Query Syntax
- SELECT
- FROM and JOIN
- WHERE
- GROUP BY
- GROUPING SETS
- HAVING
- ORDER BY
- LIMIT and OFFSET
- SAMPLE
- Unnesting
- WITH
- WINDOW
- QUALIFY
- VALUES
- FILTER
- Set Operations
- Prepared Statements
- Data Types
- Overview
- Array
- Bitstring
- Blob
- Boolean
- Date
- Enum
- Interval
- List
- Literal Types
- Map
- NULL Values
- Numeric
- Struct
- Text
- Time
- Timestamp
- Time Zones
- Union
- Typecasting
- Expressions
- Overview
- CASE Statement
- Casting
- Collations
- Comparisons
- IN Operator
- Logical Operators
- Star Expression
- Subqueries
- Functions
- Overview
- Aggregate Functions
- Array Functions
- Bitstring Functions
- Blob Functions
- Date Format Functions
- Date Functions
- Date Part Functions
- Enum Functions
- Interval Functions
- Lambda Functions
- List Functions
- Map Functions
- Nested Functions
- Numeric Functions
- Pattern Matching
- Regular Expressions
- Struct Functions
- Text Functions
- Time Functions
- Timestamp Functions
- Timestamp with Time Zone Functions
- Union Functions
- Utility Functions
- Window Functions
- Constraints
- Indexes
- Meta Queries
- DuckDB's SQL Dialect
- Samples
- Configuration
- Extensions
- Overview
- Core Extensions
- Community Extensions
- Working with Extensions
- Versioning of Extensions
- Arrow
- AutoComplete
- AWS
- Azure
- Delta
- Excel
- Full Text Search
- httpfs (HTTP and S3)
- Iceberg
- ICU
- inet
- jemalloc
- MySQL
- PostgreSQL
- Spatial
- SQLite
- Substrait
- TPC-DS
- TPC-H
- VSS
- Guides
- Overview
- Data Viewers
- Database Integration
- File Formats
- Overview
- CSV Import
- CSV Export
- Directly Reading Files
- Excel Import
- Excel Export
- JSON Import
- JSON Export
- Parquet Import
- Parquet Export
- Querying Parquet Files
- Network and Cloud Storage
- Overview
- HTTP Parquet Import
- S3 Parquet Import
- S3 Parquet Export
- S3 Iceberg Import
- S3 Express One
- GCS Import
- Cloudflare R2 Import
- DuckDB over HTTPS / S3
- Meta Queries
- Describe Table
- EXPLAIN: Inspect Query Plans
- EXPLAIN ANALYZE: Profile Queries
- List Tables
- Summarize
- DuckDB Environment
- ODBC
- Performance
- Overview
- Environment
- Import
- Schema
- Indexing
- Join Operations
- File Formats
- How to Tune Workloads
- My Workload Is Slow
- Benchmarks
- Python
- Installation
- Executing SQL
- Jupyter Notebooks
- SQL on Pandas
- Import from Pandas
- Export to Pandas
- Import from Numpy
- Export to Numpy
- SQL on Arrow
- Import from Arrow
- Export to Arrow
- Relational API on Pandas
- Multiple Python Threads
- Integration with Ibis
- Integration with Polars
- Using fsspec Filesystems
- SQL Editors
- SQL Features
- Snippets
- Glossary of Terms
- Browse Offline
- Operations Manual
- Overview
- Limits
- Non-Deterministic Behavior
- Embedding DuckDB
- DuckDB's Footprint
- Securing DuckDB
- Development
- DuckDB Repositories
- Testing
- Overview
- sqllogictest Introduction
- Writing Tests
- Debugging
- Result Verification
- Persistent Testing
- Loops
- Multiple Connections
- Catch
- Profiling
- Release Calendar
- Building
- Benchmark Suite
- Internals
- Sitemap
- Why DuckDB
- Media
- FAQ
- Code of Conduct
- Live Demo
Documentation
/ Client APIs
/ CLI
Editing
The linenoise-based CLI editor is currently only available for macOS and Linux.
DuckDB's CLI uses a line-editing library based on linenoise, which has shortcuts that are based on Emacs mode of readline. Below is a list of available commands.
Moving
Key | Action |
---|---|
Left |
Move back a character |
Right |
Move forward a character |
Up |
Move up a line. When on the first line, move to previous history entry |
Down |
Move down a line. When on last line, move to next history entry |
Home |
Move to beginning of buffer |
End |
Move to end of buffer |
Ctrl +Left |
Move back a word |
Ctrl +Right |
Move forward a word |
Ctrl +A |
Move to beginning of buffer |
Ctrl +B |
Move back a character |
Ctrl +E |
Move to end of buffer |
Ctrl +F |
Move forward a character |
Alt +Left |
Move back a word |
Alt +Right |
Move forward a word |
History
Key | Action |
---|---|
Ctrl +P |
Move to previous history entry |
Ctrl +N |
Move to next history entry |
Ctrl +R |
Search the history |
Ctrl +S |
Search the history |
Alt +< |
Move to first history entry |
Alt +> |
Move to last history entry |
Alt +N |
Search the history |
Alt +P |
Search the history |
Changing Text
Key | Action |
---|---|
Backspace |
Delete previous character |
Delete |
Delete next character |
Ctrl +D |
Delete next character. When buffer is empty, end editing |
Ctrl +H |
Delete previous character |
Ctrl +K |
Delete everything after the cursor |
Ctrl +T |
Swap current and next character |
Ctrl +U |
Delete all text |
Ctrl +W |
Delete previous word |
Alt +C |
Convert next word to titlecase |
Alt +D |
Delete next word |
Alt +L |
Convert next word to lowercase |
Alt +R |
Delete all text |
Alt +T |
Swap current and next word |
Alt +U |
Convert next word to uppercase |
Alt +Backspace |
Delete previous word |
Alt +\ |
Delete spaces around cursor |
Completing
Key | Action |
---|---|
Tab |
Autocomplete. When autocompleting, cycle to next entry |
Shift +Tab |
When autocompleting, cycle to previous entry |
Esc +Esc |
When autocompleting, revert autocompletion |
Miscellaneous
Key | Action |
---|---|
Enter |
Execute query. If query is not complete, insert a newline at the end of the buffer |
Ctrl +J |
Execute query. If query is not complete, insert a newline at the end of the buffer |
Ctrl +C |
Cancel editing of current query |
Ctrl +G |
Cancel editing of current query |
Ctrl +L |
Clear screen |
Ctrl +O |
Cancel editing of current query |
Ctrl +X |
Insert a newline after the cursor |
Ctrl +Z |
Suspend CLI and return to shell, use fg to re-open |
Using Read-Line
If you prefer, you can use rlwrap
to use read-line directly with the shell. Then, use Shift
+Enter
to insert a newline and Enter
to execute the query:
rlwrap --substitute-prompt="D " duckdb -batch