Add examples

Author: giovannibenussi

Examples/Batch/README.md

@@ -0,0 +1,13 @@
+# Batch
+
+This example demonstrates how to use libSQL to execute a batch of SQL statements.
+
+## Running
+
+Execute the example:
+
+```bash
+swift run Batch
+```
+
+This will setup a SQLite database, execute a batch of SQL statements, and then query the results.

Examples/Batch/main.swift

@@ -0,0 +1,20 @@
+
+import Foundation
+import Libsql
+
+let db = try Database(":memory:")
+let conn = try db.connect()
+
+_ = try conn.executeBatch("""
+  DROP TABLE IF EXISTS users;
+  CREATE TABLE users (id INTEGER PRIMARY KEY, email TEXT);
+  INSERT INTO users VALUES (1, 'first@example.com');
+  INSERT INTO users VALUES (2, 'second@example.com');
+  INSERT INTO users VALUES (3, 'third@example.com');
+
+""")
+
+for row in try conn.query("select * from users", [1]) {
+    print(try row.getInt(0), try row.getString(1))
+}
+

Examples/Local/.gitignore

@@ -0,0 +1 @@
+local.db*

Examples/Local/README.md

@@ -0,0 +1,13 @@
+# Local
+
+This example demonstrates how to use libSQL with a local SQLite file.
+
+## Running
+
+Execute the example:
+
+```bash
+swift run Local
+```
+
+This will setup a local SQLite database, insert some data, and then query the results.

Examples/Local/main.swift

@@ -0,0 +1,18 @@
+import Libsql
+
+let db = try Database("./local.db")
+let conn = try db.connect()
+
+_ = try conn.executeBatch("""
+  DROP TABLE IF EXISTS users;
+  CREATE TABLE users (id INTEGER PRIMARY KEY, email TEXT);
+  INSERT INTO users VALUES (1, 'first@example.com');
+  INSERT INTO users VALUES (2, 'second@example.com');
+  INSERT INTO users VALUES (3, 'third@example.com');
+
+""")
+
+for row in try conn.query("select * from users", [1]) {
+    print(try row.getInt(0), try row.getString(1))
+}
+

Examples/Memory/README.md

@@ -0,0 +1,13 @@
+# Memory
+
+This example demonstrates how to use libsql with an in-memory SQLite database.
+
+## Running
+
+Execute the example:
+
+```bash
+swift run Memory
+```
+
+This will create an in-memory SQLite database, insert some data, and then query the results.

Examples/Memory/main.swift

@@ -0,0 +1,20 @@
+
+import Foundation
+import Libsql
+
+let db = try Database(":memory:")
+let conn = try db.connect()
+
+_ = try conn.executeBatch("""
+  DROP TABLE IF EXISTS users;
+  CREATE TABLE users (id INTEGER PRIMARY KEY, email TEXT);
+  INSERT INTO users VALUES (1, 'first@example.com');
+  INSERT INTO users VALUES (2, 'second@example.com');
+  INSERT INTO users VALUES (3, 'third@example.com');
+
+""")
+
+for row in try conn.query("select * from users", [1]) {
+    print(try row.getInt(0), try row.getString(1))
+}
+

Examples/Remote/.gitignore

@@ -0,0 +1 @@
+local.db*

Examples/Remote/README.md

@@ -0,0 +1,13 @@
+# Remote
+
+This example demonstrates how to use libSQL with a remote database.
+
+## Running
+
+Execute the example:
+
+```bash
+TURSO_DATABASE_URL="..." TURSO_AUTH_TOKEN="..." swift run Remote
+```
+
+This will connect to a remote SQLite database, insert some data, and then query the results.

Examples/Remote/main.swift

@@ -0,0 +1,22 @@
+import Libsql
+import Foundation
+
+let db = try Database(
+    path: "./local.db",
+    url: ProcessInfo.processInfo.environment["TURSO_DATABASE_URL"] ?? "",
+    authToken: ProcessInfo.processInfo.environment["TURSO_AUTH_TOKEN"] ?? ""
+)
+let conn = try db.connect()
+
+_ = try conn.executeBatch("""
+  DROP TABLE IF EXISTS users;
+  CREATE TABLE users (id INTEGER PRIMARY KEY, email TEXT);
+  INSERT INTO users VALUES (1, 'first@example.com');
+  INSERT INTO users VALUES (2, 'second@example.com');
+  INSERT INTO users VALUES (3, 'third@example.com');
+
+""")
+
+for row in try conn.query("select * from users", [1]) {
+    print(try row.getInt(0), try row.getString(1))
+}

Examples/Sync/.gitignore

@@ -0,0 +1 @@
+local.db*

Examples/Sync/README.md

@@ -0,0 +1,13 @@
+# Sync
+
+This example demonstrates how to use libSQL with a synced database (local file synced with a remote database).
+
+## Running
+
+Execute the example:
+
+```bash
+TURSO_DATABASE_URL="..." TURSO_AUTH_TOKEN="..." swift run Sync
+```
+
+This will connect to a remote SQLite database, insert some data, and then query the results.

Examples/Sync/main.swift

@@ -0,0 +1,24 @@
+import Libsql
+import Foundation
+
+let db = try Database(
+    path: "./local.db",
+    url: ProcessInfo.processInfo.environment["TURSO_DATABASE_URL"] ?? "",
+    authToken: ProcessInfo.processInfo.environment["TURSO_AUTH_TOKEN"] ?? "",
+    syncInterval: 1000
+
+)
+let conn = try db.connect()
+
+_ = try conn.executeBatch("""
+  DROP TABLE IF EXISTS users;
+  CREATE TABLE users (id INTEGER PRIMARY KEY, email TEXT);
+  INSERT INTO users VALUES (1, 'first@example.com');
+  INSERT INTO users VALUES (2, 'second@example.com');
+  INSERT INTO users VALUES (3, 'third@example.com');
+
+""")
+
+for row in try conn.query("select * from users", [1]) {
+    print(try row.getInt(0), try row.getString(1))
+}

Examples/Transactions/.gitignore

@@ -0,0 +1 @@
+local.db*

Examples/Transactions/README.md

@@ -0,0 +1,22 @@
+# Transactions
+
+This example demonstrates how to use transactions with libSQL.
+
+## Running
+
+Execute the example:
+
+```bash
+swift run Transactions
+```
+
+This example will:
+
+1. Create a new table called `users`.
+2. Start a transaction.
+3. Insert multiple users within the transaction.
+4. Demonstrate how to rollback a transaction.
+5. Start another transaction.
+6. Insert more users and commit the transaction.
+7. Query and display the final state of the `users` table.
+

Examples/Transactions/main.swift

@@ -0,0 +1,30 @@
+import Foundation
+import Libsql
+
+let db = try Database(":memory:")
+let conn = try db.connect()
+
+_ = try conn.executeBatch("""
+    create table users(id integer primary key autoincrement, name text);
+    insert into users (name) values ('First Iku Turso');
+""")
+
+let tx = try conn.transaction();
+
+let fullNames = ["John Doe", "Mary Smith", "Alice Jones", "Mark Taylor"]
+
+for fullName in fullNames {
+    _ = try tx.execute(
+        "insert into users (name) values (?)",
+        [fullName]
+    );
+}
+
+tx.rollback() // Discards all inserts
+
+_ = try conn.execute("insert into users (name) values (?)", ["Second Iku Turso"])
+
+// Only returns "1 Iku turso", since the transaction was rollbacked.
+for row in try conn.query("select * from users", [1]) {
+    print(try row.getInt(0), try row.getString(1))
+}

Examples/local.db

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.10
+// swift-tools-version: 5.9.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import Foundation
@@ -14,6 +14,7 @@ var package = Package(
         .executable(name: "Query", targets: ["Query"]),
         .executable(name: "Transaction", targets: ["Transaction"]),
         .executable(name: "Vector", targets: ["Vector"]),
+        .executable(name: "Batch", targets: ["Batch"]),
     ],
     targets: [
         .target(name: "Libsql", dependencies: ["CLibsql"]),
@@ -36,5 +37,41 @@ var package = Package(
             dependencies: ["Libsql"],
             path: "Examples/Vector"
         ),
+        .executableTarget(
+            name: "Batch",
+            dependencies: ["Libsql"],
+            path: "Examples/Batch",
+            exclude: ["README.md"]
+        ),
+        .executableTarget(
+            name: "Local",
+            dependencies: ["Libsql"],
+            path: "Examples/Local",
+            exclude: ["README.md", "local.db"]
+        ),
+        .executableTarget(
+            name: "Memory",
+            dependencies: ["Libsql"],
+            path: "Examples/Memory",
+            exclude: ["README.md"]
+        ),
+        .executableTarget(
+            name: "Remote",
+            dependencies: ["Libsql"],
+            path: "Examples/Remote",
+            exclude: ["README.md", "local.db", "local.db-shm", "local.db-client_wal_index", "local.db-wal"]
+        ),
+        .executableTarget(
+            name: "Sync",
+            dependencies: ["Libsql"],
+            path: "Examples/Sync",
+            exclude: ["README.md", "local.db", "local.db-shm", "local.db-client_wal_index", "local.db-wal"]
+        ),
+        .executableTarget(
+            name: "Transactions",
+            dependencies: ["Libsql"],
+            path: "Examples/Transactions",
+            exclude: ["README.md", "local.db"]
+        ),
     ]
 )