README
¶
kubectl-sql-query
A true SQL-query enhancement for kubectl
Usage
Download the binary from releases, and install it in the PATH. For example:
curl -L https://github.com/kubideh/kubectl-sql-query/releases/download/v0.2.5/kubectl-sql-query_0.2.5_darwin_arm64.tar.gz -o - | gunzip | tar -xvf -
sudo mv kubectl-sql-query /usr/local/bin/
alias ksql=kubectl-sql-query
Query the Kubernetes API:
kubectl sql query "SELECT * FROM pods WHERE name='kube-apiserver-kind-control-plane' AND namespace='kube-system'"
SQL Query
A modified form of SQLite syntax is supported. The grammar lexer and grammar parser was sourced from the ANTLR grammars-v4.
Case-sensitivity:
Keywords are case-insensitive. For example, the keywords SELECT, Select, and select mean the same thing.
K8s object field names (columns) and their values are case-sensitive.
Field name form:
In addition to field names being case-sensitive, field names have a form that is similar to JSONPath. That is field names are addressable using dots. For example, the replicas field in a Deployment is referred to as .spec.replicas.
Fields in the metadata portion of a K8s object are the exception, and they may be addressed by just their name. For example, the field called .metadata.name may be referred to by just name. A list of the supported aliases for metadata fields now follows.
| Field | Alias |
|---|---|
.apiVersion |
apiVersion |
.kind |
kind |
.metadata.annotations |
annotations |
.metadata.creationTimestamp |
creationTimestamp |
.metadata.finalizers |
finalizers |
.metadata.generateName |
generateName |
.metadata.labels |
labels |
.metadata.name |
name |
.metadata.namespace |
namespace |
Projecting all fields:
An asterix (*) is used to project all the default columns in a table. For Kubernetes objects, all default columns means that just the name, and age columns are shown. Some examples now follow.
Project the default columns for a namespace-scoped object using an asterix:
kubectl sql query "SELECT * FROM pods WHERE name='kube-apiserver-kind-control-plane' AND namespace='kube-system'"
NAME AGE
kube-apiserver-kind-control-plane 46m
Project the default columns for a cluster-scoped object using an asterix:
kubectl sql query "SELECT * FROM clusterroles WHERE name='system:basic-user'"
NAME AGE
system:basic-user 46m
Quering for objects in all namespaces:
An asterix (*) is used as the comparator value when querying for objects in all namespaces:
kubectl sql query "SELECT * FROM pods WHERE namespace='*'"
SQL Features
Most standard or common SQL features are supported. What follows is a table that gives the collection of supported SQL features and whether they are implemented yet.
| Feature | Status |
|---|---|
| WHERE Clause | ✅ |
| = (Equal to) Comparison Operator | ✅ |
| SELECT DISTINCT | |
| AND, OR and NOT Operators | |
| IS NULL and IS NOT NULL operators | |
| SELECT TOP | |
| FETCH FIRST n ROWS ONLY, LIMIT, and ROWNUM | |
| MIN() and MAX() Functions | |
| COUNT(), AVG() and SUM() Functions | |
| LIKE Operator | |
| IN Operator | |
| BETWEEN Operator | |
| Aliases (AS Keyword) | |
| CROSS JOIN (CROSS JOIN keyword and comma-separate table names | |
| INNER JOIN | |
| OUTER JOIN | |
| LEFT JOIN | |
| RIGHT JOIN | |
| FULL OUTER JOIN and FULL JOIN | |
| Self Join | |
| UNION Operator | |
| GROUP BY Statement | |
| HAVING Clause | |
| EXISTS Operator | |
| ANY and ALL Operators | |
| CASE Statement | |
| IFNULL(), ISNULL(), COALESCE(), and NVL() Functions | |
| Comments | |
| Operators (Arithmetic, Bitwise, Comparison, Compound, Logical |
References
Most standard SQL will be supported. A list of links to the sites that were referenced when building the SQL query grammar now follows.
Documentation
¶
There is no documentation for this package.
Source Files
Directories