A tool that provides elastic and rapid filtering for efficient analysis of huge CSV files, such as eventlogs.
This project is inspired by xsv. We are currently developing a tool that can process hundreds of gigabytes of data, which is challenging for many tools, and apply filters according to predefined configurations.
Note
This project is in the early stages of development. Please be aware that frequent changes and updates are likely to occur.
In digital forensics and log analysis, it’s common to deal with extremely large CSV files—sometimes tens or even hundreds of gigabytes spread across dozens or hundreds of machines.
While many of these tasks are standardized, they often require using large, complex analysis tools with opaque specifications, or else writing intricate shell scripts that are difficult to maintain and debug.
The core feature of this tool is the quilt
command, which directly and reliably executes predefined command-line tasks.
We hope this tool will serve as a solution for anyone facing similar challenges.
This tool processes CSV files through three stages: an initializer, one or more chainable functions, and a finalizer. For example, you can load a csv file in the initializer, use chainable functions to filter, sort, and select columns, and then output the resulting csv file in the finalizer.
$ qsv {{INITIALIZER}} {{Arguments}} - {{CHAINABLE}} {{Arguments}} - {{FINALIZER}} {{Arguments}}
Each process must be explicitly separated by a hyphen ("-").
e.g. Below is an example of reading a CSV file, extracting rows that contain 4624 in the 'Event ID' column, and displaying the top 3 rows sorted by the 'Date and Time' column.
$ qsv load Security.csv - isin 'Event ID' 4624 - sort 'Date and Time' - head 3
shape: (3, 5)
┌─────────────┬───────────────────────┬─────────────────────────────────┬──────────┬───────────────┐
│ Level ┆ Date and Time ┆ Source ┆ Event ID ┆ Task Category │
│ --- ┆ --- ┆ --- ┆ --- ┆ --- │
│ str ┆ str ┆ str ┆ i64 ┆ str │
╞═════════════╪═══════════════════════╪═════════════════════════════════╪══════════╪═══════════════╡
│ Information ┆ 10/6/2016 01:00:55 PM ┆ Microsoft-Windows-Security-Aud… ┆ 4624 ┆ Logon │
│ Information ┆ 10/6/2016 01:04:05 PM ┆ Microsoft-Windows-Security-Aud… ┆ 4624 ┆ Logon │
│ Information ┆ 10/6/2016 01:04:10 PM ┆ Microsoft-Windows-Security-Aud… ┆ 4624 ┆ Logon │
└─────────────┴───────────────────────┴─────────────────────────────────┴──────────┴───────────────┘
Loads the specified CSV files.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | path | tuple[str] | The character used to separate fields within the CSV file. | |
Option | separator | str | "," | The character used to split values. |
Option | low_memory | bool | False | If True, enables a lower-memory processing mode, beneficial for handling very large files. |
$ qsv load ./Security.csv
$ qsv load ./logs/*.csv
Selects only the specified columns.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colnames | Union[str, tuple[str]] | Specifies the column(s) to keep. Accepts a single column name or multiple column names. |
$ qsv load ./Security.csv - select 'Event ID'
$ qsv load ./Security.csv - select "Date and Time-Event ID"
$ qsv load ./Security.csv - select "'Date and Time,Event ID'"
Filters rows containing the specified values.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colname | str | The name of the column to filter. | |
Argument | values | list[str] | A list of values to match. Rows that contain any of these values in the column are kept. |
$ qsv load ./Security.csv - isin 'Event ID' 4624,4634
Filters rows where the specified column matches the given regex.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colname | str | The name of the column to test against the regex pattern. | |
Argument | pattern | str | A regular expression pattern used for matching values in the column. | |
Argument | ignorecase | bool | False | If True, performs case-insensitive pattern matching. |
$ qsv load ./Security.csv - contains 'Date and Time' '10/6/2016'
Replaces values using the specified regex.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colname | str | The name of the column whose values will be modified. | |
Argument | pattern | str | A regular expression pattern identifying substrings to replace. | |
Argument | replacement | str | The text that replaces matched substrings. | |
Argument | ignorecase | bool | False | If True, the regex matching is performed in a case-insensitive manner. |
$ qsv load ./Security.csv - sed 'Date and Time' '/' '-'
Treats all columns as strings and filters rows where any column matches the specified regex.
This function is similar to running a grep command while preserving the header row.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | pattern | str | A regular expression pattern used to filter rows. Any row with a match is kept. | |
Argument | ignorecase | bool | False | If True, the regex match is case-insensitive. |
$ qsv load ./Security.csv - grep 'LogonType'
Selects only the first N lines.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Option | number | int | 5 | The number of rows to display from the start. |
$ qsv load ./Security.csv - head 10
Selects only the last N lines.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Option | number | int | 5 | The number of rows to display from the end. |
$ qsv load ./Security.csv - tail 10
Sorts all rows by the specified column values.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colnames | Union[str, tuple[str], list[str]] | One or more columns to sort by. | |
Option | desc | bool | False | If True, sorts in descending order rather than ascending. |
$ qsv load ./Security.csv - sort 'Date and Time'
Remove duplicate rows based on the specified column names.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colnames | Union[str, tuple[str], list[str]] | Column(s) used to determine uniqueness. Rows with duplicate values are removed. |
$ qsv load ./Security.csv - uniq 'Event ID'
Changes the timezone of the specified date column.
The datetime format strings follow the same conventions as Python's datetime module (based on the C99 standard).
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colname | str | The name of the date/time column to convert. | |
Option | timezone_from | str | "UTC" | The original timezone of the column's values. |
Option | timezone_to | str | "UTC" | The target timezone to convert values into. |
Option | datetime_format | str | AutoDetect | The datetime format for parsing values. If not provided, the format is automatically inferred. |
$ qsv load ./Security.csv - changetz 'Date and Time' --timezone_from=UTC --timezone_to=Asia/Tokyo --datetime_format="%m/%d/%Y %I:%M:%S %p"
Renames the specified column.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | colname | str | The current name of the column to rename. | |
Argument | new_colname | str | The new name for the specified column. |
$ qsv load ./Security.csv - renamecol 'Event ID' 'EventID'
Displays the column names of the data.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Option | plain | bool | False | If True, displays the column headers as plain text rather than a table. |
$ qsv load ./Security.csv - headers
┏━━━━┳━━━━━━━━━━━━━━━┓
┃ # ┃ Column Name ┃
┡━━━━╇━━━━━━━━━━━━━━━┩
│ 00 │ Level │
│ 01 │ Date and Time │
│ 02 │ Source │
│ 03 │ Event ID │
│ 04 │ Task Category │
└────┴───────────────┘
Displays the statistical information of the data.
$ qsv load ./Security.csv - stats
shape: (9, 6)
┌────────────┬─────────────┬───────────────────────┬─────────────────────────────────┬─────────────┬─────────────────────────┐
│ statistic ┆ Level ┆ Date and Time ┆ Source ┆ Event ID ┆ Task Category │
│ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │
│ str ┆ str ┆ str ┆ str ┆ f64 ┆ str │
╞════════════╪═════════════╪═══════════════════════╪═════════════════════════════════╪═════════════╪═════════════════════════╡
│ count ┆ 62031 ┆ 62031 ┆ 62031 ┆ 62031.0 ┆ 62031 │
│ null_count ┆ 0 ┆ 0 ┆ 0 ┆ 0.0 ┆ 0 │
│ mean ┆ null ┆ null ┆ null ┆ 5058.625897 ┆ null │
│ std ┆ null ┆ null ┆ null ┆ 199.775419 ┆ null │
│ min ┆ Information ┆ 10/6/2016 01:00:35 PM ┆ Microsoft-Windows-Eventlog ┆ 1102.0 ┆ Credential Validation │
│ 25% ┆ null ┆ null ┆ null ┆ 5152.0 ┆ null │
│ 50% ┆ null ┆ null ┆ null ┆ 5156.0 ┆ null │
│ 75% ┆ null ┆ null ┆ null ┆ 5157.0 ┆ null │
│ max ┆ Information ┆ 10/7/2016 12:59:59 AM ┆ Microsoft-Windows-Security-Aud… ┆ 5158.0 ┆ User Account Management │
└────────────┴─────────────┴───────────────────────┴─────────────────────────────────┴─────────────┴─────────────────────────┘
Displays the data processing query.
$ qsv load Security.csv - showquery
naive plan: (run LazyFrame.explain(optimized=True) to see the optimized plan)
Csv SCAN Security.csv
PROJECT */5 COLUMNS
Displays the processing results in a table format to standard output.
$ qsv load Security.csv - show
Level,Date and Time,Source,Event ID,Task Category
Information,10/7/2016 06:38:24 PM,Microsoft-Windows-Security-Auditing,4658,File System
Information,10/7/2016 06:38:24 PM,Microsoft-Windows-Security-Auditing,4656,File System
Information,10/7/2016 06:38:24 PM,Microsoft-Windows-Security-Auditing,4658,File System
Information,10/7/2016 06:38:24 PM,Microsoft-Windows-Security-Auditing,4656,File System
Information,10/7/2016 06:38:24 PM,Microsoft-Windows-Security-Auditing,4658,File System
Outputs the processing results table to the standard output.
$ qsv load Security.csv - showtable
shape: (3, 5)
┌─────────────┬───────────────────────┬─────────────────────────────────┬──────────┬───────────────┐
│ Level ┆ Date and Time ┆ Source ┆ Event ID ┆ Task Category │
│ --- ┆ --- ┆ --- ┆ --- ┆ --- │
│ str ┆ str ┆ str ┆ i64 ┆ str │
╞═════════════╪═══════════════════════╪═════════════════════════════════╪══════════╪═══════════════╡
│ Information ┆ 10/6/2016 01:00:55 PM ┆ Microsoft-Windows-Security-Aud… ┆ 4624 ┆ Logon │
│ Information ┆ 10/6/2016 01:04:05 PM ┆ Microsoft-Windows-Security-Aud… ┆ 4624 ┆ Logon │
│ Information ┆ 10/6/2016 01:04:10 PM ┆ Microsoft-Windows-Security-Aud… ┆ 4624 ┆ Logon │
└─────────────┴───────────────────────┴─────────────────────────────────┴──────────┴───────────────┘
Outputs the processing results to a CSV file.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Option | path | str | yyyymmdd-HHMMSS_{QUERY}.csv | The file path where the filtered/output CSV data will be saved. If not specified, a timestamp-based filename is used. |
$ qsv load Security.csv - dump ./Security-qsv.csv
Quilt is a command that allows you to predefine a series of Initializer, Chainable Functions, and Finalizer processes in a YAML configuration file, and then execute them all at once.
Category | Parameter | Data Type | Default Value | Description |
---|---|---|---|---|
Argument | config | str | The path to a YAML configuration file defining a set of initialization, transformation, and finalization steps. | |
Argument | path | tuple[str] | One or more paths to CSV files to be processed according to the predefined rules in the configuration file. |
$ qsv quilt rules ./Security.csv
rules/test.yaml
title: test
description: test filter
version: 0.1.0
author: John Doe <john@example.com>
rules:
load:
isin:
colname: EventId
values:
- 4624
head:
number: 5
select:
colnames:
- RecordNumber
- TimeCreated
changetz:
colname: TimeCreated
timezone_from: UTC
timezone_to: Asia/Tokyo
datetime_format: "%Y-%m-%d %H:%M:%S%.f"
showtable:
- CSV cache (.pkl, duckdb, etc.)
- Logical condition-based filtering (e.g., OR, AND) for more complex queries.
- Grouping for operations like count
- Support for joining data with other tables.
$ pip install qsv
A Nuitka-compiled binary version is also available.
$ chmod +x ./qsv
$ ./qsv {{options...}}
> qsv.exe {{options...}}
Quilter-CSV is released under the MIT License.