Search through your filesystem with SQL-esque queries.
$ go get -u -v github.com/kshvmdn/fsql/...
$ which fsql
$GOPATH/bin/fsql
$ brew install fsql
$ which fsql
/usr/local/bin/fsql
$ git clone https://github.com/kshvmdn/fsql.git $GOPATH/src/github.com/kshvmdn/fsql
$ cd $_ # $GOPATH/src/github.com/kshvmdn/fsql
$ make
$ ./fsql
fsql expects a single query via stdin. You may also choose to use fsql in interactive mode.
View the usage dialogue with the -help
flag.
$ fsql -help
usage: fsql [options] [query]
-v print version and exit (shorthand)
-version
print version and exit
In general, each query requires a SELECT
clause (to specify which attributes will be shown), a FROM
clause (to specify which directories to search), and a WHERE
clause (to specify conditions to test against).
>>> SELECT attribute, ... FROM source, ... WHERE condition;
You may choose to omit the SELECT
and WHERE
clause.
If you're providing your query via stdin, quotes are not required, however you'll have to escape reserved characters (e.g. *
, <
, >
, etc).
Currently supported attributes include name
, size
, time
, hash
, mode
.
Use all
or *
to choose all; if no attribute is provided, this is chosen by default.
Examples:
Each group features a set of equivalent clauses.
>>> SELECT name, size, time ...
>>> name, size, time ...
>>> SELECT all FROM ...
>>> all FROM ...
>>> FROM ...
Each source should be a relative or absolute path to a directory on your machine.
Source paths may include environment variables (e.g. $GOPATH
) or tildes (~
). Use a hyphen (-
) to exclude a directory. Source paths also support usage of glob patterns.
In the case that a directory begins with a hyphen (e.g. -foo
), use the following to include it as a source:
>>> ... FROM ./-foo ...
Examples:
>>> ... FROM . ...
>>> ... FROM ~/Desktop, ./*/**.go ...
>>> ... FROM $GOPATH, -.git/ ...
A single condition is made up of 3 parts: an attribute, an operator, and a value.
-
Attribute:
A valid attribute is any of the following:
name
,size
,mode
,time
. -
Operator:
Each attribute has a set of associated operators.
-
name
:Operator Description =
String equality <>
/!=
Synonymous to using "NOT ... = ..."
IN
Basic list inclusion LIKE
Simple pattern matching. Use %
to match zero, one, or multiple characters. Check that a string begins with a value:<value>%
, ends with a value:%<value>
, or contains a value:%<value>%
.RLIKE
Pattern matching with regular expressions. -
size
/time
:- All basic algebraic operators:
>
,>=
,<
,<=
,=
, and<>
/!=
.
- All basic algebraic operators:
-
hash
:=
or<>
/!=
-
mode
:IS
-
-
Value:
If the value contains spaces, wrap the value in quotes (either single or double) or backticks.
The default unit for
size
is bytes.The default format for
time
isMMM DD YYYY HH MM
(e.g."Jan 02 2006 15 04"
).Use
mode
to test if a file is regular (IS REG
) or if it's a directory (IS DIR
).Use
hash
to compute and/or compare the hash value of a file. The default algorithm isSHA1
Use AND
/ OR
to join conditions. Note that precedence is assigned based on order of appearance.
This means WHERE a AND b OR c
is not the same as WHERE c OR b AND a
. Use parentheses to get around this behaviour, i.e. WHERE a AND b OR c
is the same as WHERE c OR (b AND a)
.
Examples:
>>> ... WHERE name = main.go OR size = 5 ...
>>> ... WHERE name = main.go AND size > 20 ...
Use NOT
to negate a condition. This keyword must precede the condition (e.g. ... WHERE NOT a ...
).
Note that negating parenthesized conditions is currently not supported. However, this can easily be resolved by applying De Morgan's laws to your query. For example, ... WHERE NOT (a AND b) ...
is logically equivalent to ... WHERE NOT a OR NOT b ...
(the latter is actually more optimal, due to lazy evaluation).
Examples:
>>> ... WHERE NOT name = main.go ...
Attribute modifiers are used to specify how input and output values should be processed. These functions are applied directly to attributes in the SELECT
and WHERE
clauses.
The table below lists currently-supported modifiers. Note that the first parameter to FORMAT
is always the attribute name.
Attribute | Modifier | Supported in SELECT |
Supported in WHERE |
---|---|---|---|
hash |
SHA1(, n) |
✔️ | ✔️ |
name |
UPPER (synonymous to FORMAT(, UPPER) ) |
✔️ | ✔️ |
LOWER (synonymous to FORMAT(, LOWER) ) |
✔️ | ✔️ | |
FULLPATH |
✔️ | ||
SHORTPATH |
✔️ | ||
size |
FORMAT(, unit) |
✔️ | ✔️ |
time |
FORMAT(, layout) |
✔️ | ✔️ |
-
n
:Specify the length of the hash value. Use a negative integer or
ALL
to display all digits. -
unit
:Specify the size unit. One of:
B
(byte),KB
(kilobyte),MB
(megabyte), orGB
(gigabyte). -
layout
:Specify the time layout. One of:
ISO
,UNIX
, or custom. Custom layouts must be provided in reference to the following date:Mon Jan 2 15:04:05 -0700 MST 2006
.
Examples:
>>> SELECT SHA1(hash, 20) ...
>>> ... WHERE UPPER(name) ...
>>> SELECT FORMAT(size, MB) ...
>>> ... WHERE FORMAT(time, "Mon Jan 2 2006 15:04:05") ...
Subqueries allow for more complex condition statements. These queries are recursively evaluated while parsing. SELECTing multiple attributes in a subquery is not currently supported; if more than one attribute (or all
) is provided, only the first attribute is used.
Support for referencing superqueries is not yet implemented, see #4 if you'd like to help with this.
Examples:
>>> ... WHERE name IN (SELECT name FROM ../foo) ...
List all attributes of each directory in your home directory (note the escaped *
):
$ fsql SELECT \* FROM ~ WHERE mode IS DIR
List the names of all files in the Desktop and Downloads directory that contain csc
in the name:
$ fsql "SELECT name FROM ~/Desktop, ~/Downloads WHERE name LIKE %csc%"
List all files in the current directory that are also present in some other directory:
$ fsql
>>> SELECT all FROM . WHERE name IN (
... SELECT name FROM ~/Desktop/files.bak/
... );
Passing queries via stdin without quotes is a bit of a pain, hopefully the next examples highlight that, my suggestion is to use interactive mode or wrap the query in quotes if you're doing anything with subqueries or attribute modifiers.
List all files named main.go
in $GOPATH
which are larger than 10.5 kilobytes or smaller than 100 bytes:
$ fsql SELECT all FROM $GOPATH WHERE name = main.go AND \(FORMAT\(size, KB\) \>= 10.5 OR size \< 100\)
$ fsql "SELECT all FROM $GOPATH WHERE name = main.go AND (FORMAT(size, KB) >= 10.5 OR size < 100)"
$ fsql
>>> SELECT
... all
... FROM
... $GOPATH
... WHERE
... name = main.go
... AND (
... FORMAT(size, KB) >= 10.5
... OR size < 100
... )
... ;
List the name, size, and modification time of JavaScript files in the current directory that were modified after April 1st 2017:
$ fsql SELECT UPPER\(name\), FORMAT\(size, KB\), FORMAT\(time, ISO\) FROM . WHERE name LIKE %.js AND time \> \'Apr 01 2017 00 00\'
$ fsql "SELECT UPPER(name), FORMAT(size, KB), FORMAT(time, ISO) FROM . WHERE name LIKE %.js AND time > 'Apr 01 2017 00 00'"
$ fsql
>>> SELECT
... UPPER(name),
... FORMAT(size, KB),
... FORMAT(time, ISO)
... FROM
... .
... WHERE
... name LIKE %.js
... AND time > 'Apr 01 2017 00 00'
... ;
This project is completely open source, feel free to open an issue or submit a pull request.
Before submitting code, please ensure that tests are passing and the linter is happy. The following commands may be of use, refer to the Makefile to see what they do.
$ make install \
get-tools
$ make fmt \
vet \
lint
$ make test \
coverage
$ make bootstrap-dist \
dist
fsql source code is available under the MIT license.