chore: code cleaning, preparing for v1.0.0

Author: andinux

MAKEFILE.md

@@ -0,0 +1,19 @@
+# SQLite Cloud go-sdk Makefile
+
+### Run the test for the SDK
+If you want to run the Test programs: `make test`
+
+### Building the CLI App
+To build the CLI App, you have to enter: `make cli`
+
+### Build all at the same time:
+If you want to do all at the same time: `make all`
+
+## Documentation
+If you want to see the Documentation: `make doc` - Warning: A browser window will open and display the documentation to you. The Documentation is updated live while coding. To stop the live mode, press CRTL-C on the command line.
+
+## Development helpers
+- Check files with gosec: `make checksec`
+- Open the repo in github: `make github`.
+- See changes: `make diff`
+- Clean dependencies and precompiled code: `make clean`

README.md

@@ -1,19 +1,88 @@
-# SQLite Cloud GO Client
 
-### Run the test for the SDK
-If you want to run the Test programs: `make test`
+# Introduction
 
-### Building the CLI App
-To build the CLI App, you have to enter: `make cli`
+The SQLite Cloud Client SDK for Go (sqlitecloud/go-sdk) is the Go Programming Language application programmer's interface to [SQLite Cloud](https://sqlitecloud.io/). 
 
-### Build all at the same time:
-If you want to do all at the same time: `make all`
+It is a set of library functions that allow client programs to pass queries and SQL commands to the SQLite Cloud backend server and to receive the results of these queries. In addition to the standard SQLite statements, several other [commands](https://docs.sqlitecloud.io/docs/commands) are supported.
 
-## Documentation
-If you want to see the Documentation: `make doc` - Warning: A browser window will open and display the documentation to you. The Documentation is updated live while coding. To stop the live mode, press CRTL-C on the command line.
+# Getting Started
 
-## Development helpers
-- Check files with gosec: `make checksec`
-- Open the repo in github: `make github`.
-- See changes: `make diff`
-- Clean dependencies and precompiled code: `make clean`
+## Use the SQLite Cloud Client SDK in your Go code  
+
+1. Import the package in your Go source code 
+
+   ```
+   import sqlitecloud "github.com/sqlitecloud/go-sdk"
+   ```
+
+2. download the package, run the [`go mod tidy` command](https://go.dev/ref/mod#go-mod-tidy) to synchronize your module's dependencies:
+
+   ```
+   $ go mod tidy 
+   go: downloading github.com/sqlitecloud/go-sdk v1.0.0
+   ```
+
+3. Connect to SQLite Cloud database with a valid [connection string](#get-a-connection-string)
+
+   ```
+   db, err := sqlitecloud.Connect("sqlitecloud://user:pass@host.sqlite.cloud:port/dbname")
+   ```
+
+4. Execute queries using a [method](#api-documentation) defined on the `SQCloud` struct, for example `Select`:
+
+   ```
+   result, _ := db.Select("SELECT * FROM table1;")
+   ```
+
+
+
+The following example shows how to print the content of the table `table1`:
+
+```
+package main
+
+import (
+	"fmt"
+	"strings"
+
+	sqlitecloud "github.com/sqlitecloud/go-sdk"
+)
+
+const connectionString = "sqlitecloud://admin:password@host.sqlite.cloud:8860/dbname.sqlite"
+
+func main() {
+	db, err := sqlitecloud.Connect(connectionString)
+	if err != nil {
+		fmt.Println("Connect error: ", err)
+	}
+
+	tables, _ := db.ListTables()
+	fmt.Printf("Tables: \n\t%s\n", strings.Join(tables, "\n\t"))
+
+	fmt.Printf("Table1:\n")
+	result, _ := db.Select("SELECT * FROM t1;")
+	for r := uint64(0); r < result.GetNumberOfRows(); r++ {
+		id, _ := result.GetInt64Value(r, 0)
+		value, _ := result.GetStringValue(r, 1)
+		fmt.Printf("\t%d: %s\n", id, value)
+	}
+}
+```
+
+## Get a connection string
+
+You can connect to any cloud database using a special connection string in the form:
+
+`sqlitecloud://user:pass@host.com:port/dbname?timeout=10&key2=value2&key3=value3`
+
+To get a valid connection string just follow these instructions:
+
+- Get a [SQLite Cloud](https://sqlitecloud.io/) account. See the [documentation](https://docs.sqlitecloud.io/docs/introduction/login) for details.
+- Create a [SQLite Cloud project](https://docs.sqlitecloud.io/docs/introduction/projects)
+- Create a [SQLite Cloud database](https://docs.sqlitecloud.io/docs/introduction/databases)
+- Get the connection string by clicking on the node address in the [Dashboard Nodes](https://docs.sqlitecloud.io/docs/introduction/nodes) section. A valid connection string for  twill be copied in your clipboard.
+- add the database name to your connection string
+
+## API Documentation
+
+The complete documentation of the sqlitecloud/go-sdk library is available at: https://pkg.go.dev/github.com/sqlitecloud/go-sdk

connection.go

@@ -222,7 +222,7 @@ func (this *SQCloud) CheckConnectionParameter() error {
 		case "":
 			break
 		case SQLiteCloudCA:
-			pem = []byte(SqliteCloudCAPEM)
+			pem = []byte(sqliteCloudCAPEM)
 		default:
 			// check if it is a filepath
 			_, err := os.Stat(trimmed)

pem.go

@@ -17,7 +17,7 @@
 
 package sqlitecloud
 
-const SqliteCloudCAPEM = `-----BEGIN CERTIFICATE-----
+const sqliteCloudCAPEM = `-----BEGIN CERTIFICATE-----
 MIID6zCCAtOgAwIBAgIUI0lTm5CfVf3mVP8606CkophcyB4wDQYJKoZIhvcNAQEL
 BQAwgYQxCzAJBgNVBAYTAklUMQswCQYDVQQIDAJNTjEQMA4GA1UEBwwHVmlhZGFu
 YTEbMBkGA1UECgwSU1FMaXRlIENsb3VkLCBJbmMuMRQwEgYDVQQDDAtTUUxpdGVD

result.go

@@ -107,7 +107,6 @@ func (this *Result) Dump() {
 }
 
 // ToJSON returns a JSON representation of this query result.
-// BUG(andreas): The Result.ToJSON method is not implemented yet.
 func (this *Result) ToJSON() string {
 	buf := new(bytes.Buffer)
 	_, _ = this.DumpToWriter(bufio.NewWriter(buf), OUTFORMAT_JSON, false, "<AUTO>", "NULL", "", 0, false)

row.go

@@ -34,7 +34,6 @@ type ResultRow struct {
 }
 
 // ToJSON returns a JSON representation of this query result row.
-// BUG(andreas): The ResultRow.ToJSON method is not implemented yet.
 func (this *ResultRow) ToJSON() ([]byte, error) { return json.Marshal(this) }
 
 // IsFirst returns true if this query result row is the first in the result set, false otherwise.
@@ -113,7 +112,6 @@ func (this *ResultRow) GetName(Column uint64) (string, error) { return this.resu
 
 // GetMaxWidth returns the number of runes of the value in the specified column with the maximum length in this query result.
 // The Column index is an unsigned int in the range of 0...GetNumberOfColumns() - 1.
-// BUG(andreas): Rename GetWidth->GetmaxWidth
 func (this *ResultRow) GetMaxWidth(Column uint64) (uint64, error) {
 	return this.result.GetMaxColumnWidth(Column)
 }

server.go

@@ -388,8 +388,8 @@ func (this *SQCloud) SetKey(Key string, Value string) error {
 
 // GetKey gets the Value of the key Key and returns it as a string value.
 // If the Key was not found an error is returned.
-// BUG(andreas): If key is not set, DB returns NULL -> does not work with current implementation
 func (this *SQCloud) GetKey(Key string) (string, error) {
+	// BUG(andreas): If key is not set, DB returns NULL -> does not work with current implementation
 	result, err := this.SelectArray("GET KEY ?", []interface{}{Key})
 	if result != nil {
 		defer result.Free()