It's recommended to keep it active only for the time strictly necessary to identify and optimize queries. +
+ SQLite Cloud Example: Checking Chinook Customers +
+ +
+
+
+
+
+
+
+
+ Results:
+
+
+```
+ - Lastly, in `sqlitecloud_quickstart/settings.py`, configure `DIRS` in `TEMPLATES` as follows.
+ - `'APP_DIRS': True` tells Django's templating engine to look for template source files inside project apps.
+ - `DIRS` provides the filepath to the correct app's `templates` dir.
+
+```python
+TEMPLATES = [
+ {
+ 'BACKEND': 'django.template.backends.django.DjangoTemplates',
+ 'DIRS': ['albums/templates'],
+ 'APP_DIRS': True,
+ 'OPTIONS': {
+ 'context_processors': [
+ 'django.template.context_processors.debug',
+ 'django.template.context_processors.request',
+ 'django.contrib.auth.context_processors.auth',
+ 'django.contrib.messages.context_processors.messages',
+ ],
+ },
+ },
+]
+```
+
+5. **Run the Django dev server**
+
+```bash
+python manage.py runserver
+```
+
+ - Visit `http://127.0.0.1:8000/albums/` to see your app data.
+
+6. **FOLLOW-UP:**
+This Quickstart goes a bit deeper into the framework than the other Quickstarts since Django requires more boilerplate to get up-and-running with a simple app.
+
+If you're new to Django and want to learn more, we referenced the following Django Tutorial pages extensively when writing this Quickstart:
+ - Part 1
+ - Part 3
+
+And that's it! You've successfully built a Django app that reads data from a SQLite Cloud database.
\ No newline at end of file
diff --git a/sqlite-cloud/quickstart/quick-start-flask.mdx b/sqlite-cloud/quickstart/quick-start-flask.mdx
new file mode 100644
index 0000000..dfe33ec
--- /dev/null
+++ b/sqlite-cloud/quickstart/quick-start-flask.mdx
@@ -0,0 +1,80 @@
+---
+title: Flask Quick Start Guide
+description: Get started with SQLite Cloud using Flask.
+category: getting-started
+status: publish
+slug: quick-start-flask
+---
+
+In this quickstart, we will show you how to get started with SQLite Cloud and Flask by building a simple application that connects to and reads from a SQLite Cloud database.
+
+---
+
+1. **Set up a SQLite Cloud account**
+ - If you haven't already, sign up for a SQLite Cloud account and create a new project.
+ - In this guide, we will use the sample datasets that come pre-loaded with SQLite Cloud.
+
+2. **Create a Flask app**
+ - You should have the latest Python version (3) installed locally.
+
+```bash
+mkdir sqlc-quickstart
+cd sqlc-quickstart
+
+python3 -m venv .venv
+. .venv/bin/activate
+
+pip install flask
+```
+
+3. **Install the SQLite Cloud SDK**
+
+```bash
+pip install sqlitecloud
+```
+
+4. **Query data**
+ - Copy the following code into a new `app.py` file.
+ - In your SQLite Cloud account dashboard, click on a Node, copy the Connection String, and replace `Albums
+-
+ {% for row in albumObjsList %}
+
- {{ row.album }} by {{ row.artist }} + {% endfor %} +
Albums
' + + for row in cursor: + album = f"{row[1]} by {row[2]}" + result += f"Albums
+-
+@foreach ($albums as $album)
+
- {{ $album['albumTitle'] }} by {{ $album['artistName'] }} +@endforeach +
+
+ );
+ } catch (error) {
+ let message = "An unknown error occurred";
+
+ if (error instanceof Error) {
+ message = error.message;
+ }
+ return + Albums (Server Component) +
+-
+ {result.map((album: Album) => (
+
- + {album.title} -{" "} + {album.artist} + + ))} +
Error loading albums: {message}
; + } finally { + db?.close(); + } +} +``` + +10. **Fetch Data in a Client Component** +Since the SQLite Cloud driver can run in the browser, you can use it directly in a Client Component without needing an API route. + +```tsx +// +// src/app/components/GetAlbumsClient.tsx (Client Component) +// + +"use client"; + +import { useEffect, useState } from "react"; +import { Database } from "@sqlitecloud/drivers"; +import { Album } from "@/types"; +import { GET_ALBUMS } from "@/constants/queries"; + +export default function GetAlbumsClient() { + const [albums, setAlbums] = useStateError: {error}
; + + return ( +
+
+ );
+}
+```
+
+11. **Update Data in a Client Component**
+You can also update data directly from a Client Component:
+
+```tsx
+//
+// src/app/components/UpdateAlbumsClient.tsx (Client Component)
+//
+
+"use client";
+
+import { useState, useEffect } from "react";
+
+export default function UpdateAlbumsClient() {
+ const [albums, setAlbums] = useState<
+ { id: number; title: string; artist: string }[]
+ >([]);
+ const [loading, setLoading] = useState(false);
+
+ // Function to fetch albums from the API route
+ async function fetchAlbums() {
+ try {
+ const res = await fetch("/api/albums");
+ if (!res.ok) throw new Error("Failed to fetch albums");
+ const data = await res.json();
+ setAlbums(data);
+ } catch (error) {
+ console.error("Error fetching albums:", error);
+ }
+ }
+
+ // Function to add a new album and then reload the albums list
+ async function addAlbum() {
+ setLoading(true);
+
+ try {
+ // Generate a random album name
+ const randomAlbumTitle = `Album ${Math.random()
+ .toString(36)
+ .substring(7)}`;
+
+ // Generate a random artist ID between 1 and 100
+ const randomArtistId = Math.floor(Math.random() * 100) + 1;
+
+ const res = await fetch("/api/albums", {
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify({
+ title: randomAlbumTitle,
+ artistId: randomArtistId,
+ }),
+ });
+
+ if (!res.ok) throw new Error("Failed to add album");
+
+ await fetchAlbums(); // Refresh album list after adding
+ } catch (error) {
+ console.error("Error adding album:", error);
+ } finally {
+ setLoading(false);
+ }
+ }
+
+ // Fetch albums when component mounts
+ useEffect(() => {
+ fetchAlbums();
+ }, []);
+
+ return (
+ Albums (Client Component)
+ {error ? ( +Error: {error}
+ ) : ( +-
+ {albums.map((album) => (
+
- + {album.title} -{" "} + {album.artist} + + ))} +
+
+
+
+ );
+}
+
+```
+
+12. **Create a Page to Display Components**
+
+Replace the content of `page.tsx` with:
+
+```tsx
+//
+// src/app/page.tsx (Unified Page)
+//
+
+import GetAlbumsClient from "./components/GetAlbumsClient";
+import GetAlbumsServer from "./components/GetAlbumsServer";
+import UpdateAlbumsClient from "./components/UpdateAlbumsClient";
+
+export default function page() {
+ return (
+ Latest Albums
+ {albums.length === 0 ? ( +No albums found.
+ ) : ( +-
+ {albums.map((album) => (
+
- + {album.title} -{" "} + {album.artist} + + ))} +
+
+ );
+}
+```
+
+Replace the content of `layout.tsx` with:
+
+```tsx
+//
+// src/app/layout.tsx
+//
+
+export default function RootLayout({
+ children,
+}: {
+ children: React.ReactNode;
+}) {
+ return (
+
+
+ {/* ✅ Add Tailwind CDN */}
+
+
+ {children}
+
+ );
+}
+
+```
+
+13. **Run Your App**
+```bash
+npm run dev
+```
+
+14. **View Your App**
+ - Open your browser and navigate to the provided localhost link to see your app in action.
+
+
+---
+
+Congratulations! You’ve successfully built a Next.js app that interacts with a SQLite Cloud database.
\ No newline at end of file
diff --git a/sqlite-cloud/quickstart/quick-start-node.mdx b/sqlite-cloud/quickstart/quick-start-node.mdx
new file mode 100644
index 0000000..419a0af
--- /dev/null
+++ b/sqlite-cloud/quickstart/quick-start-node.mdx
@@ -0,0 +1,68 @@
+---
+title: Node.js Quick Start Guide
+description: Get started with SQLite Cloud using Node.js and Express.
+category: getting-started
+status: publish
+slug: quick-start-node
+---
+
+In this quickstart, we will show you how to get started with SQLite Cloud and Node.js by building a simple web server that connects to and reads from a SQLite Cloud database, then serves that data to the client.
+
+---
+
+1. **Set up a SQLite Cloud account**
+ - If you haven't already, sign up for a SQLite Cloud account and create a new project.
+ - In this guide, we will use the sample datasets that come pre-loaded with SQLite Cloud.
+2. **Create a Node.js app**
+ - Navigate to your target directory and run the following command to initialize your Node.js app and install the necessary depedencies:
+```bash
+npm init
+```
+ - After creating your project, install the SQLite Cloud SDK:
+```bash
+npm install express @sqlitecloud/drivers --save
+```
+ - Create a file named `index.js` in the root directory of your project.
+
+3. **Query data**
+ - Grab a connection string by clicking on a node in your dashboard.
+ - Paste the following into your `index.js` file:
+
+```javascript
+const express = require("express");
+const { Database } = require("@sqlitecloud/drivers");
+
+const connectionString = process.env.SQLITECLOUD_CONNECTION_STRING
+const app = express();
+
+app.get("/albums", async (req, res) => {
+ let db = null;
+ try {
+ db = new Database(connectionString)
+ const result = await db.sql(`
+ USE DATABASE chinook.sqlite;
+ SELECT albums.AlbumId as id, albums.Title as title, artists.name as artist
+ FROM albums
+ INNER JOIN artists
+ WHERE artists.ArtistId = albums.ArtistId
+ LIMIT 20;`);
+ res.json(result);
+ } catch (error) {
+ res.status(500).json({ error: error.message });
+ } finally {
+ db?.close();
+ }
+});
+
+app.listen(3000, () => {
+ console.log("Server running on port 3000");
+});
+```
+5. **Run your app**
+```bash
+node index.js
+```
+6. **View your web server response**
+ - Open your browser and navigate to `http://localhost:3000/albums` to see your app in action.
+
+And that's it! You've successfully built a Node.js app that reads and serves data from a SQLite Cloud database.
diff --git a/sqlite-cloud/quickstart/quick-start-prisma.mdx b/sqlite-cloud/quickstart/quick-start-prisma.mdx
new file mode 100644
index 0000000..f0fb1c5
--- /dev/null
+++ b/sqlite-cloud/quickstart/quick-start-prisma.mdx
@@ -0,0 +1,87 @@
+---
+title: Prisma Quick Start Guide
+description: Get started with SQLite Cloud using Prisma ORM.
+category: getting-started
+status: draft
+slug: quick-start-prisma
+---
+
+In this quickstart, we will show you how to get started with SQLite Cloud and Prisma by building a simple application that connects to and reads from a SQLite Cloud database.
+
+---
+
+1. **Set up a SQLite Cloud account**
+ - If you haven't already, sign up for a SQLite Cloud account and create a new project.
+ - In this guide, we will use the sample datasets that come pre-loaded with SQLite Cloud.
+2. **Create a Next.js app**
+ - Create a Next app using ```create-next-app```. The following command creates a very simple app (JS, no Tailwind, uses the latest App Router) to keep the focus on querying the data.
+```bash
+npx create-next-app@latest sqlc-quickstart --js --no-tailwind --eslint --app --src-dir --import-alias "@/*" --use-npm
+```
+3. **Install the SQLite Cloud SDK**
+```bash
+cd sqlc-quickstart && npm install @sqlitecloud/drivers
+```
+4. **Query data**
+ - Replace the code in ```layout.js``` and ```page.js``` with the following snippets.
+ - Click a node in your account dashboard and copy the connection string. Replace ```
+
+ Albums Overview
+ +
+
+
+
+
+
+
+
+
+
+ );
+}
+```
+
+5. **Run your app**
+```bash
+npm run dev
+```
+6. **View your app**
+ - Open your browser and navigate to the localhost link provided by the previous command to see your app data.
+
+And that's it! You've successfully built a Next app that reads data from a SQLite Cloud database.
\ No newline at end of file
diff --git a/sqlite-cloud/quickstart/quick-start-react-native.mdx b/sqlite-cloud/quickstart/quick-start-react-native.mdx
new file mode 100644
index 0000000..8ba114f
--- /dev/null
+++ b/sqlite-cloud/quickstart/quick-start-react-native.mdx
@@ -0,0 +1,115 @@
+---
+title: React Native Quick Start Guide
+description: Get started with SQLite Cloud using React Native.
+category: getting-started
+status: publish
+slug: quick-start-react-native
+---
+
+In this quickstart, we will show you how to get started with SQLite Cloud and React Native by building a simple application that connects to and reads from a SQLite Cloud database.
+
+---
+
+1. **Set up a SQLite Cloud account**
+ - If you haven't already, sign up for a SQLite Cloud account and create a new project.
+ - In this guide, we will use the sample datasets that come pre-loaded with SQLite Cloud.
+
+2. **Create a React Native project**
+ - If you haven't already, sign up for an Expo account.
+ - Create a new remote EAS project with the name `sqlc-quickstart`.
+ - Link your remote project to a new local project. Replace `{id}` below with the project ID provided by Expo.
+
+```bash
+npm install --global eas-cli
+npx create-expo-app sqlc-quickstart
+cd sqlc-quickstart
+eas init --id {id}
+```
+
+3. **Install the SQLite Cloud JS SDK and peer dependencies**
+
+```bash
+npm install @sqlitecloud/drivers react-native-tcp-socket react-native-fast-base64
+```
+
+4. **Query data**
+ - Replace the code in `app/(tabs)/index.tsx` with the following snippet.
+ - In your SQLite Cloud account dashboard, click on a Node, copy the Connection String, and replace `Albums
+-
+ {res.map(({ id, title, artist }) => (
+
- + {title} by {artist} + + ))} +
+
+ );
+}
+
+export default App
+```
+5. **Run your app**
+```bash
+npm run dev
+```
+6. **View your app**
+ - Open your browser and navigate to the localhost link provided by the previous command to see your app data.
+
+And that's it! You've successfully built a React app that reads data from a SQLite Cloud database.
+
diff --git a/sqlite-cloud/quickstart/quick-start-sqlalchemy-orm.mdx b/sqlite-cloud/quickstart/quick-start-sqlalchemy-orm.mdx
new file mode 100644
index 0000000..9a723c7
--- /dev/null
+++ b/sqlite-cloud/quickstart/quick-start-sqlalchemy-orm.mdx
@@ -0,0 +1,167 @@
+---
+title: SQLAlchemy ORM Quick Start Guide
+description: Get started with SQLite Cloud using SQLAlchemy ORM in FastAPI.
+category: getting-started
+status: publish
+slug: quick-start-sqlalchemy-orm
+---
+
+In this Quick Start, we will show you how to get started with SQLite Cloud by building a FastAPI backend that connects to and reads from a SQLite Cloud database using SQLAlchemy.
+
+NOTE that FastAPI framework:
+ - does NOT require you to use a relational database or any database at all.
+ - CAN work with any ORM library (including SQLAlchemy) or database (including SQLite, which comes pre-installed in Python and is a database supported by SQLAlchemy).
+ - code is MINIMAL in the example below. Most of the code is standard SQLAlchemy and framework-agnostic.
+
+---
+
+1. **Set up a SQLite Cloud account**
+ - If you haven't already, sign up for a SQLite Cloud account and create a new project.
+ - In this guide, we will use the sample datasets that come pre-loaded with SQLite Cloud.
+
+2. **Create a new Python project**
+ - You should have the latest Python version (3) installed locally.
+
+```bash
+mkdir sqlalchemy-quickstart
+cd sqlalchemy-quickstart
+
+# open the project in VSCode / another editor
+code .
+
+python3 -m venv .venv
+. .venv/bin/activate
+```
+
+3. **Install dependencies**
+ - Run this command from your current directory:
+
+```bash
+pip install "fastapi[standard]" sqlalchemy sqlalchemy-sqlitecloud
+```
+
+ - Do NOT remove the quotes around the FastAPI package.
+ - `sqlalchemy-sqlitecloud` includes `sqlitecloud`, so no need to install the latter separately.
+
+4. **App setup**
+ - From your current directory, create a sub-directory `fastapi_sqlc_app` with an empty `__init__.py` file to indicate the new sub-directory is a package.
+ - NOTE: We will create all remaining project files in this sub-directory.
+
+```bash
+mkdir fastapi_sqlc_app
+cd fastapi_sqlc_app
+touch __init__.py
+```
+
+ - Create a new file `database.py` and copy in the following code.
+ - In your SQLite Cloud account dashboard, click on `Show connection strings`, copy the Connection String, and replace `Albums
+-
+ {data.map((album) => (
+
- {album.title} by {album.artist} + ))} +
+
+
++ + +
+
+
++ + +
+
+
++ + +
+
+
+SQLite Cloud for Go is a powerful package that allows you to interact with the SQLite Cloud database seamlessly. It provides methods for various database operations. This package is designed to simplify database operations in Go applications, making it easier than ever to work with SQLite Cloud. In addition to the standard SQLite statements, several other [commands](server-side-commands) are supported.
\ No newline at end of file
diff --git a/sdk/js/classes/Database.md b/sqlite-cloud/sdks/js/classes/Database.md
similarity index 84%
rename from sdk/js/classes/Database.md
rename to sqlite-cloud/sdks/js/classes/Database.md
index df2793c..c625d9a 100644
--- a/sdk/js/classes/Database.md
+++ b/sqlite-cloud/sdks/js/classes/Database.md
@@ -1,6 +1,9 @@
---
title: Database
description: SQLite Cloud Javascript SDK
+customClass: sdk-doc js-doc
+category: sdks
+status: publish
---
Creating a Database object automatically opens a connection to the SQLite database.
@@ -81,7 +84,7 @@ EventEmitter.constructor
#### Defined in
-[src/drivers/database.ts:33](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L33)
+src/drivers/database.ts:33
• **new Database**(`config`, `mode?`, `callback?`): [`Database`](database)
@@ -103,7 +106,7 @@ EventEmitter.constructor
#### Defined in
-[src/drivers/database.ts:34](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L34)
+src/drivers/database.ts:34
## Properties
@@ -115,7 +118,7 @@ Configuration used to open database connections
#### Defined in
-[src/drivers/database.ts:57](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L57)
+src/drivers/database.ts:57
___
@@ -127,7 +130,7 @@ Database connections
#### Defined in
-[src/drivers/database.ts:60](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L60)
+src/drivers/database.ts:60
___
@@ -212,7 +215,7 @@ calls to retrieve a previously unknown amount of rows.
#### Defined in
-[src/drivers/database.ts:273](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L273)
+src/drivers/database.ts:273
▸ **all**\<`T`\>(`sql`, `params`, `callback?`): [`Database`](database)
@@ -236,7 +239,7 @@ calls to retrieve a previously unknown amount of rows.
#### Defined in
-[src/drivers/database.ts:274](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L274)
+src/drivers/database.ts:274
___
@@ -263,7 +266,7 @@ parameters is emitted, regardless of whether a callback was provided or not.
#### Defined in
-[src/drivers/database.ts:394](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L394)
+src/drivers/database.ts:394
___
@@ -286,7 +289,7 @@ Set a configuration option for the database
#### Defined in
-[src/drivers/database.ts:190](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L190)
+src/drivers/database.ts:190
___
@@ -327,7 +330,7 @@ way to abort execution.
#### Defined in
-[src/drivers/database.ts:312](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L312)
+src/drivers/database.ts:312
▸ **each**\<`T`\>(`sql`, `params`, `callback?`, `complete?`): [`Database`](database)
@@ -352,7 +355,7 @@ way to abort execution.
#### Defined in
-[src/drivers/database.ts:313](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L313)
+src/drivers/database.ts:313
___
@@ -408,7 +411,7 @@ Emits given event with optional arguments on the next tick so callbacks can comp
#### Defined in
-[src/drivers/database.ts:160](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L160)
+src/drivers/database.ts:160
___
@@ -459,7 +462,7 @@ will be emitted on the database object.
#### Defined in
-[src/drivers/database.ts:368](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L368)
+src/drivers/database.ts:368
___
@@ -495,7 +498,7 @@ the only supported way is by column name.
#### Defined in
-[src/drivers/database.ts:235](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L235)
+src/drivers/database.ts:235
▸ **get**\<`T`\>(`sql`, `params`, `callback?`): [`Database`](database)
@@ -519,7 +522,7 @@ the only supported way is by column name.
#### Defined in
-[src/drivers/database.ts:236](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L236)
+src/drivers/database.ts:236
___
@@ -539,7 +542,7 @@ A configuration object
#### Defined in
-[src/drivers/database.ts:176](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L176)
+src/drivers/database.ts:176
___
@@ -561,7 +564,7 @@ Returns first available connection from connection pool
#### Defined in
-[src/drivers/database.ts:67](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L67)
+src/drivers/database.ts:67
___
@@ -585,7 +588,7 @@ Handles an error by closing the connection, calling the callback and/or emitting
#### Defined in
-[src/drivers/database.ts:117](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L117)
+src/drivers/database.ts:117
___
@@ -604,7 +607,7 @@ open to use this function.
#### Defined in
-[src/drivers/database.ts:429](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L429)
+src/drivers/database.ts:429
___
@@ -685,7 +688,7 @@ Loads a compiled SQLite extension into the database connection object.
#### Defined in
-[src/drivers/database.ts:413](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L413)
+src/drivers/database.ts:413
___
@@ -819,7 +822,7 @@ they are bound to the prepared statement before calling the callback.
#### Defined in
-[src/drivers/database.ts:353](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L353)
+src/drivers/database.ts:353
___
@@ -851,7 +854,7 @@ https://github.com/TryGhost/node-sqlite3/wiki/API#runsql--param---callback
#### Defined in
-[src/drivers/database.ts:141](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L141)
+src/drivers/database.ts:141
___
@@ -945,7 +948,7 @@ which it was called to allow for function chaining.
#### Defined in
-[src/drivers/database.ts:202](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L202)
+src/drivers/database.ts:202
▸ **run**\<`T`\>(`sql`, `params`, `callback?`): [`Database`](database)
@@ -969,7 +972,7 @@ which it was called to allow for function chaining.
#### Defined in
-[src/drivers/database.ts:203](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L203)
+src/drivers/database.ts:203
___
@@ -998,7 +1001,7 @@ metadata in case of insert, update, delete.
#### Defined in
-[src/drivers/database.ts:447](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L447)
+src/drivers/database.ts:447
___
@@ -1014,4 +1017,4 @@ Enable verbose mode
#### Defined in
-[src/drivers/database.ts:181](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/database.ts#L181)
+src/drivers/database.ts:181
diff --git a/sdk/js/classes/SQLiteCloudConnection.md b/sqlite-cloud/sdks/js/classes/SQLiteCloudConnection.md
similarity index 70%
rename from sdk/js/classes/SQLiteCloudConnection.md
rename to sqlite-cloud/sdks/js/classes/SQLiteCloudConnection.md
index 63d7bb2..d428d66 100644
--- a/sdk/js/classes/SQLiteCloudConnection.md
+++ b/sqlite-cloud/sdks/js/classes/SQLiteCloudConnection.md
@@ -1,6 +1,9 @@
---
title: SQLiteCloudConnection
description: SQLite Cloud Javascript SDK
+customClass: sdk-doc js-doc
+category: sdks
+status: publish
---
Base class for SQLiteCloudConnection handles basics and defines methods.
@@ -52,7 +55,7 @@ Parse and validate provided connectionString or configuration
#### Defined in
-[src/drivers/connection.ts:16](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L16)
+src/drivers/connection.ts:16
## Properties
@@ -64,7 +67,7 @@ Configuration passed by client or extracted from connection string
#### Defined in
-[src/drivers/connection.ts:28](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L28)
+src/drivers/connection.ts:28
___
@@ -76,7 +79,7 @@ Operations are serialized by waiting an any pending promises
#### Defined in
-[src/drivers/connection.ts:31](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L31)
+src/drivers/connection.ts:31
## Accessors
@@ -92,7 +95,7 @@ Returns true if connection is open
#### Defined in
-[src/drivers/connection.ts:74](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L74)
+src/drivers/connection.ts:74
## Methods
@@ -108,7 +111,7 @@ Disconnect from server, release transport.
#### Defined in
-[src/drivers/connection.ts:100](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L100)
+src/drivers/connection.ts:100
___
@@ -130,7 +133,7 @@ Connect will establish a tls or websocket transport to the server based on confi
#### Defined in
-[src/drivers/connection.ts:38](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L38)
+src/drivers/connection.ts:38
___
@@ -151,7 +154,7 @@ ___
#### Defined in
-[src/drivers/connection.ts:56](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L56)
+src/drivers/connection.ts:56
___
@@ -174,7 +177,7 @@ Will log to console if verbose mode is enabled
#### Defined in
-[src/drivers/connection.ts:62](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L62)
+src/drivers/connection.ts:62
___
@@ -197,7 +200,7 @@ Will enquee a command to be executed and callback with the resulting rowset/resu
#### Defined in
-[src/drivers/connection.ts:82](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L82)
+src/drivers/connection.ts:82
___
@@ -220,7 +223,7 @@ Send a command, return the rowset/result or throw an error
#### Defined in
-[src/drivers/connection.ts:59](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L59)
+src/drivers/connection.ts:59
___
@@ -236,4 +239,4 @@ Enable verbose logging for debug purposes
#### Defined in
-[src/drivers/connection.ts:77](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/connection.ts#L77)
+src/drivers/connection.ts:77
diff --git a/sdk/js/classes/SQLiteCloudError.md b/sqlite-cloud/sdks/js/classes/SQLiteCloudError.md
similarity index 82%
rename from sdk/js/classes/SQLiteCloudError.md
rename to sqlite-cloud/sdks/js/classes/SQLiteCloudError.md
index 494e3c4..eea1af3 100644
--- a/sdk/js/classes/SQLiteCloudError.md
+++ b/sqlite-cloud/sdks/js/classes/SQLiteCloudError.md
@@ -1,6 +1,9 @@
---
title: SQLiteCloudError
description: SQLite Cloud Javascript SDK
+customClass: sdk-doc js-doc
+category: sdks
+status: publish
---
Custom error reported by SQLiteCloud drivers
@@ -56,7 +59,7 @@ Error.constructor
#### Defined in
-[src/drivers/types.ts:102](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/types.ts#L102)
+src/drivers/types.ts:102
## Properties
@@ -72,7 +75,7 @@ Error.cause
#### Defined in
-[src/drivers/types.ts:111](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/types.ts#L111)
+src/drivers/types.ts:111
___
@@ -84,7 +87,7 @@ Error code returned by drivers or server
#### Defined in
-[src/drivers/types.ts:113](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/types.ts#L113)
+src/drivers/types.ts:113
___
@@ -96,7 +99,7 @@ Additional error code
#### Defined in
-[src/drivers/types.ts:115](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/types.ts#L115)
+src/drivers/types.ts:115
___
@@ -136,7 +139,7 @@ Additional offset code in commands
#### Defined in
-[src/drivers/types.ts:117](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/types.ts#L117)
+src/drivers/types.ts:117
___
diff --git a/sdk/js/classes/SQLiteCloudRow.md b/sqlite-cloud/sdks/js/classes/SQLiteCloudRow.md
similarity index 65%
rename from sdk/js/classes/SQLiteCloudRow.md
rename to sqlite-cloud/sdks/js/classes/SQLiteCloudRow.md
index 241b3cb..d0eea36 100644
--- a/sdk/js/classes/SQLiteCloudRow.md
+++ b/sqlite-cloud/sdks/js/classes/SQLiteCloudRow.md
@@ -1,6 +1,9 @@
---
title: SQLiteCloudRow
description: SQLite Cloud Javascript SDK
+customClass: sdk-doc js-doc
+category: sdks
+status: publish
---
A single row in a dataset with values accessible by column name
@@ -47,7 +50,7 @@ Column values are accessed by column name
#### Defined in
-[src/drivers/rowset.ts:9](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L9)
+src/drivers/rowset.ts:9
## Properties
@@ -57,7 +60,7 @@ Column values are accessed by column name
#### Defined in
-[src/drivers/rowset.ts:21](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L21)
+src/drivers/rowset.ts:21
___
@@ -67,7 +70,7 @@ ___
#### Defined in
-[src/drivers/rowset.ts:18](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L18)
+src/drivers/rowset.ts:18
## Methods
@@ -83,7 +86,7 @@ Returns rowset data as a plain array of values
#### Defined in
-[src/drivers/rowset.ts:31](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L31)
+src/drivers/rowset.ts:31
___
@@ -99,4 +102,4 @@ Returns the rowset that this row belongs to
#### Defined in
-[src/drivers/rowset.ts:25](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L25)
+src/drivers/rowset.ts:25
diff --git a/sdk/js/classes/SQLiteCloudRowset.md b/sqlite-cloud/sdks/js/classes/SQLiteCloudRowset.md
similarity index 95%
rename from sdk/js/classes/SQLiteCloudRowset.md
rename to sqlite-cloud/sdks/js/classes/SQLiteCloudRowset.md
index 30cb365..472551d 100644
--- a/sdk/js/classes/SQLiteCloudRowset.md
+++ b/sqlite-cloud/sdks/js/classes/SQLiteCloudRowset.md
@@ -1,6 +1,9 @@
---
title: SQLiteCloudRowset
description: SQLite Cloud Javascript SDK
+customClass: sdk-doc js-doc
+category: sdks
+status: publish
---
## Hierarchy
@@ -95,7 +98,7 @@ Array\<SQLiteCloudRow\>.constructor
#### Defined in
-[src/drivers/rowset.ts:41](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L41)
+src/drivers/rowset.ts:41
## Properties
@@ -107,7 +110,7 @@ Actual data organized in rows
#### Defined in
-[src/drivers/rowset.ts:72](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L72)
+src/drivers/rowset.ts:72
___
@@ -119,7 +122,7 @@ Metadata contains number of rows and columns, column names, types, etc.
#### Defined in
-[src/drivers/rowset.ts:69](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L69)
+src/drivers/rowset.ts:69
___
@@ -165,7 +168,7 @@ Array of columns names
#### Defined in
-[src/drivers/rowset.ts:93](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L93)
+src/drivers/rowset.ts:93
___
@@ -181,7 +184,7 @@ Get rowset metadata
#### Defined in
-[src/drivers/rowset.ts:98](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L98)
+src/drivers/rowset.ts:98
___
@@ -197,7 +200,7 @@ Number of columns in row set
#### Defined in
-[src/drivers/rowset.ts:88](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L88)
+src/drivers/rowset.ts:88
___
@@ -213,7 +216,7 @@ Number of rows in row set
#### Defined in
-[src/drivers/rowset.ts:83](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L83)
+src/drivers/rowset.ts:83
___
@@ -233,7 +236,7 @@ https://github.com/sqlitecloud/sdk/blob/master/PROTOCOL.md
#### Defined in
-[src/drivers/rowset.ts:78](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L78)
+src/drivers/rowset.ts:78
## Methods
@@ -519,7 +522,7 @@ Array.filter
#### Defined in
-[src/drivers/rowset.ts:141](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L141)
+src/drivers/rowset.ts:141
___
@@ -723,7 +726,7 @@ Return value of item at given row and column
#### Defined in
-[src/drivers/rowset.ts:103](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L103)
+src/drivers/rowset.ts:103
___
@@ -874,7 +877,7 @@ Array.map
#### Defined in
-[src/drivers/rowset.ts:131](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L131)
+src/drivers/rowset.ts:131
___
@@ -1142,7 +1145,7 @@ Array.slice
#### Defined in
-[src/drivers/rowset.ts:113](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/rowset.ts#L113)
+src/drivers/rowset.ts:113
___
diff --git a/sdk/js/classes/Statement.md b/sqlite-cloud/sdks/js/classes/Statement.md
similarity index 73%
rename from sdk/js/classes/Statement.md
rename to sqlite-cloud/sdks/js/classes/Statement.md
index 9cf1baf..efbb082 100644
--- a/sdk/js/classes/Statement.md
+++ b/sqlite-cloud/sdks/js/classes/Statement.md
@@ -1,6 +1,9 @@
---
title: Statement 
+
++ +
+
++ +
+
++ +
+
++ +
+
+
+## Install
+
+```bash
+npm install @sqlitecloud/drivers
+```
+
+## Usage
+
+```ts
+import { Database } from '@sqlitecloud/drivers'
+
+let database = new Database('sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.db')
+
+let name = 'Breaking The Rules'
+
+let results = await database.sql`SELECT * FROM tracks WHERE name = ${name}`
+// => returns [{ AlbumId: 1, Name: 'Breaking The Rules', Composer: 'Angus Young... }]
+```
+
+Use [Database.sql](/docs/sqlite-cloud/sdks/js/classes/database#sql) to execute prepared statements or plain SQL queries asynchronously. This method returns an array of rows for SELECT queries and supports the standard syntax for UPDATE, INSERT, and DELETE.
+
+We aim for full compatibility with the established sqlite3 API, with the primary distinction being that our driver connects to SQLiteCloud databases. This allows you to migrate your SQLite to the cloud while continuing to use your existing codebase.
+
+The package is developed entirely in TypeScript and is fully compatible with JavaScript. It doesn't require any native libraries. This makes it a straightforward and effective tool for managing cloud-based databases in a familiar SQLite environment.
+
+## More
+
+How do I deploy SQLite in the cloud?
++How do I connect SQLite cloud with Javascript? +
+How can I contribute or suggest features? diff --git a/sdk/js/modules.md b/sqlite-cloud/sdks/js/modules.md similarity index 62% rename from sdk/js/modules.md rename to sqlite-cloud/sdks/js/modules.md index c991449..4b9c81d 100644 --- a/sdk/js/modules.md +++ b/sqlite-cloud/sdks/js/modules.md @@ -1,23 +1,27 @@ --- title: Modules description: SQLite Cloud Javascript SDK +customClass: sdk-doc js-doc +category: sdks +status: publish +slug: sdk-js-modules --- ## Table of contents ### Classes -- [Database](classes/database) -- [SQLiteCloudConnection](classes/sqlitecloudconnection) -- [SQLiteCloudError](classes/sqliteclouderror) -- [SQLiteCloudRow](classes/sqlitecloudrow) -- [SQLiteCloudRowset](classes/sqlitecloudrowset) -- [Statement](classes/statement) +- [Database](sqlite-cloud/sdks/js/classes/database) +- [SQLiteCloudConnection](sqlite-cloud/sdks/js/classes/sqlitecloudconnection) +- [SQLiteCloudError](sqlite-cloud/sdks/js/classes/sqliteclouderror) +- [SQLiteCloudRow](sqlite-cloud/sdks/js/classes/sqlitecloudrow) +- [SQLiteCloudRowset](sqlite-cloud/sdks/js/classes/sqlitecloudrowset) +- [Statement](sqlite-cloud/sdks/js/classes/statement) ### Interfaces -- [SQLCloudRowsetMetadata](interfaces/sqlcloudrowsetmetadata) -- [SQLiteCloudConfig](interfaces/sqlitecloudconfig) +- [SQLCloudRowsetMetadata](sqlite-cloud/sdks/js/interfaces/sqlcloudrowsetmetadata) +- [SQLiteCloudConfig](sqlite-cloud/sdks/js/interfaces/sqlitecloudconfig) ### Type Aliases @@ -52,7 +56,7 @@ description: SQLite Cloud Javascript SDK #### Defined in -[src/drivers/types.ts:120](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/types.ts#L120) +src/drivers/types.ts:120 ## Functions @@ -74,7 +78,7 @@ Takes a generic value and escapes it so it can replace ? as a binding in a prepa #### Defined in -[src/drivers/utilities.ts:70](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/utilities.ts#L70) +src/drivers/utilities.ts:70 ___ @@ -96,7 +100,7 @@ Parse connectionString like sqlitecloud://username:password@host:port/database?o #### Defined in -[src/drivers/utilities.ts:210](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/utilities.ts#L210) +src/drivers/utilities.ts:210 ___ @@ -119,7 +123,7 @@ Take a sql statement and replaces ? or $named parameters that are properly seria #### Defined in -[src/drivers/utilities.ts:105](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/utilities.ts#L105) +src/drivers/utilities.ts:105 ___ @@ -141,4 +145,4 @@ Validate configuration, apply defaults, throw if something is missing or misconf #### Defined in -[src/drivers/utilities.ts:173](https://github.com/sqlitecloud/sqlitecloud-js/blob/f7cd658/src/drivers/utilities.ts#L173) +src/drivers/utilities.ts:173 diff --git a/sqlite-cloud/sdks/php/introduction.mdx b/sqlite-cloud/sdks/php/introduction.mdx new file mode 100644 index 0000000..2d9603a --- /dev/null +++ b/sqlite-cloud/sdks/php/introduction.mdx @@ -0,0 +1,100 @@ +--- +title: PHP SDK Getting Started +description: Get started with SQLite Cloud using PHP. +category: sdks +status: publish +slug: sdk-php-introduction +--- + +This powerful package provides methods that simplify performing database operations in PHP applications, making it easier than ever to work with SQLite in the cloud. We encourage all users to log encountered issues in the SDK’s issues backlog. + +## Install + + - Run the following command to initialize a PHP project and install the SDK. + +```bash +$ composer require sqlitecloud/sqlitecloud +``` + +## Configure your database connection + + - In your SQLite Cloud account dashboard, click on `Show connection strings`, copy the Connection String, and replace `