Merge first parts of rewrite

.github/workflows/gobuild.yaml → .github/workflows/build.yaml

@@ -1,4 +1,4 @@
-name: Go build
+name: Build
 on: [push]
 
 jobs:
@@ -10,8 +10,8 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v4
         with:
-          go-version: '1.21.x'
-      - name: Install dependencies
-        run: go get .
+          go-version-file: go.mod
+          cache-dependency-path: |
+            go.sum
       - name: Build
         run: go build -v ./cmd/pavosql

.github/workflows/gotest.yaml → .github/workflows/test.yaml

@@ -1,4 +1,4 @@
-name: Go test
+name: Test
 on: [push]
 
 jobs:
@@ -10,8 +10,8 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v4
         with:
-          go-version: '1.21.x'
-      - name: Install dependencies
-        run: go get .
+          go-version-file: go.mod
+          cache-dependency-path: |
+            go.sum
       - name: Test with the Go CLI
         run: go test -v ./...

.gitignore

@@ -21,9 +21,4 @@ bin
 # Go workspace file
 go.work
 
-# Hugo Docs
-docs/.hugo_build.lock
-public
-docs/public
-
 dist/

.golangci.toml

@@ -0,0 +1,40 @@
+version = '2'
+
+[linters]
+default = 'none'
+enable = [
+  'errcheck',
+  'gosec',
+  'govet',
+  'ineffassign',
+  'lll',
+  'staticcheck',
+  'unused'
+]
+
+[linters.exclusions]
+generated = 'lax'
+presets = [
+  'comments',
+  'common-false-positives',
+  'legacy',
+  'std-error-handling'
+]
+paths = [
+  'third_party$',
+  'builtin$',
+  'examples$'
+]
+
+[formatters]
+enable = [
+  'gofmt'
+]
+
+[formatters.exclusions]
+generated = 'lax'
+paths = [
+  'third_party$',
+  'builtin$',
+  'examples$'
+]

README.md

@@ -1,37 +1,38 @@
-# PavoSQL
+<div align="center">
+  <a href="https://github.com/gkits/pavosql">
+    <img src="assets/pavosql-gopher.png" alt="pavosql gopher" width="240" height="240">
+  </a>
+  <h1 align="center">PavoSQL</h1>
+  <p align="center">
+  </p>
+</div>
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
-[![Build](https://github.com/gKits/PavoSQL/actions/workflows/gobuild.yaml/badge.svg)](https://github.com/gKits/PavoSQL/actions/workflows/gobuild.yaml)
-[![Test](https://github.com/gKits/PavoSQL/actions/workflows/gotest.yaml/badge.svg)](https://github.com/gKits/PavoSQL/actions/workflows/gotest.yaml)
-[![Build Hugo docs and deploy to pages](https://github.com/gKits/PavoSQL/actions/workflows/hugo.yaml/badge.svg)](https://gkits.github.io/PavoSQL)
+[![Build](https://github.com/gkits/pavosql/actions/workflows/build.yaml/badge.svg)](https://github.com/gkits/pavosql/actions/workflows/build.yaml)
+[![Test](https://github.com/gkits/pavosql/actions/workflows/test.yaml/badge.svg)](https://github.com/gkits/pavosql/actions/workflows/test.yaml)
 
-**This is a learning project and is not meant to be run in production environments.**
-
-**This project is stil w.i.p.**
-
-PavoSQL is a SQL relational Database written in pure Go, meaning only using Go's standard library.
+**This is project is still work in progress and not supposed to be used in any productive setting.**
 
 ## Roadmap
 
-- [x] Atomic backend store on single file
-- [ ] Relational model build on KV Store
-    - [ ] Point queries
-    - [ ] Range queries
-    - [ ] Insert
-    - [ ] Delete
-    - [ ] Sorting
-    - [ ] Group By
-    - [ ] Joins
-- [ ] Lexer and Parser for SQL queries
-- [ ] Database server and client to use PavoSQL over the network
-- [ ] User and privilege system
+- [ ] Database engine
+  - [ ] Single file backend
+    - [ ] B+tree structure
+    - [ ] Concurrent r/w
+    - [ ] Atomic i/o
+  - [ ] SQL
+    - [ ] Relational model
+      - [ ] Tables
+      - [ ] Indexes
+      - [ ] Metadata
+    - [ ] Lexer, parser and AST
+    - [ ] Query functionality
+- [ ] Network
+  - [ ] Server + client
+  - [ ] Authentication + Authorization
 - [ ] Implement [database/sql](https://pkg.go.dev/database/sql) driver interface
-- [ ] Database Management System in single directory
-- [ ] Windows compatibilty of backend store (remain atomic)
 - [ ] Documentation
-- [ ] Installable as service/daemon (e.g. systemd)
-- [ ] Create and release Docker image
-- [ ] 80% Test coverage (not needed but nice to have)
+- [ ] Docker image
 
 ## Reference material
 

cmd/pavofmt/main.go

@@ -0,0 +1 @@
+package main

cmd/pavosql/cmd/root.go

@@ -0,0 +1,37 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/gkits/pavosql/cmd/pavosql/cmd/serve"
+	"github.com/gkits/pavosql/cmd/pavosql/cmd/version"
+	"github.com/spf13/cobra"
+)
+
+var rootCmd = &cobra.Command{
+	Use:   "pavosql",
+	Short: "A brief description of your application",
+	Long: `A longer description that spans multiple lines and likely contains
+examples and usage of using your application. For example:
+
+Cobra is a CLI library for Go that empowers applications.
+This application is a tool to generate the needed files
+to quickly create a Cobra application.`,
+	// Uncomment the following line if your bare application
+	// has an action associated with it:
+	// Run: func(cmd *cobra.Command, args []string) { },
+}
+
+func Execute() {
+	err := rootCmd.Execute()
+	if err != nil {
+		os.Exit(1)
+	}
+}
+
+func init() {
+	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+
+	rootCmd.AddCommand(version.Command())
+	rootCmd.AddCommand(serve.Command())
+}

cmd/pavosql/cmd/serve/serve.go

@@ -0,0 +1,24 @@
+package serve
+
+import (
+	"github.com/spf13/cobra"
+)
+
+var (
+	port uint16
+)
+
+func Command() *cobra.Command {
+	var serveCmd = &cobra.Command{
+		Use:   "serve",
+		Short: "",
+		Long:  "",
+		Run: func(cmd *cobra.Command, args []string) {
+			// TODO: start server
+		},
+	}
+
+	serveCmd.Flags().Uint16VarP(&port, "port", "p", 6677, "")
+
+	return serveCmd
+}

cmd/pavosql/cmd/version/version.go

@@ -0,0 +1,18 @@
+package version
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+func Command() *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "",
+		Long:  "",
+		Run: func(cmd *cobra.Command, args []string) {
+			fmt.Println("v0.0.0")
+		},
+	}
+}

cmd/pavosql/main.go

@@ -1,3 +1,30 @@
+/*
+MIT License
+
+# Copyright (c) 2023 Georgios Kitsikoudis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
 package main
 
-func main() {}
+import "github.com/gkits/pavosql/cmd/pavosql/cmd"
+
+func main() {
+	cmd.Execute()
+}

docs.go

@@ -0,0 +1,24 @@
+/*
+MIT License
+
+# Copyright (c) 2023 Georgios Kitsikoudis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+package pavosql