PocketBase

https://pocketbase.io/docs
Admin
PocketBase is an open source backend consisting of an embedded database (SQLite) with realtime...
Tokens:280,534
Snippets:1,573
Trust Score:9.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Route pattern matching examples for GET routes

Source: https://pocketbase.io/docs/js-routing

Illustrates various route patterns supported by PocketBase's router, including exact host/path matching, wildcard trailing slash, named wildcard parameters, and the special `{$}` parameter to indicate end of URL. These follow Go's `net/http.ServeMux` rules.

```javascript
// match "GET example.com/index.html"
routerAdd("GET", "example.com/index.html", ...)

// match "GET /index.html" (for any host)
routerAdd("GET", "/index.html", ...)

// match "GET /static/", "GET /static/a/b/c", etc.
routerAdd("GET", "/static/", ...)

// match "GET /static/", "GET /static/a/b/c", etc.
// (similar to the above but with a named wildcard parameter)
routerAdd("GET", "/static/{path...}", ...)

// match only "GET /static/" (if no "/static" is registered, it is 301 redirected)
routerAdd("GET", "/static/{$}", ...)

// match "GET /customers/john", "GET /customers/jane", etc.
routerAdd("GET", "/customers/{name}", ...)
```

--------------------------------

### OnServe hook example with route registration

Source: https://pocketbase.io/docs/go-event-hooks

Registers a handler for the OnServe hook, triggered when the web server starts (after TCP listener, before blocking serve task). Allows adjusting options and attaching new routes or middlewares; example adds a GET /hello route with RequireAuth.

```go
package main

import (
	"log"
	"net/http"

	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/apis"
	"github.com/pocketbase/pocketbase/core"
)

func main() {
	app := pocketbase.New()

	app.OnServe().BindFunc(func(e *core.ServeEvent) error {
		// register new "GET /hello" route
		e.Router.GET("/hello", func(e *core.RequestEvent) error {
			return e.String(200, "Hello world!")
		}).Bind(apis.RequireAuth())
		return e.Next()
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### Start SSH session to server

Source: https://pocketbase.io/docs/going-to-production

Starts an SSH session with the remote server to begin the deployment process.

```bash
ssh root@YOUR_SERVER_IP
```

--------------------------------

### Start PocketBase production server with domain

Source: https://pocketbase.io/docs/going-to-production

Starts the PocketBase production server with auto-managed TLS via Let's Encrypt. Specifying a domain name issues a certificate. Running as root allows binding to privileged ports 80 and 443.

```bash
[root@dev ~]$ /root/pb/pocketbase serve yourdomain.com
```

--------------------------------

### Start PocketBase with test data directory

Source: https://pocketbase.io/docs/go-testing

Starts the PocketBase server with a custom test data directory and disables automigration. Use this to create test data via the Dashboard before running integration tests.

```bash
./pocketbase serve --dir="./test_pb_data" --automigrate=0
```

--------------------------------

### Start PocketBase with --encryptionEnv flag

Source: https://pocketbase.io/docs/going-to-production

Start PocketBase with settings encryption enabled by passing the --encryptionEnv flag set to the environment variable name that holds the 32-character encryption key.

```bash
pocketbase serve --encryptionEnv=PB_ENCRYPTION_KEY
```

--------------------------------

### Enable and start PocketBase systemd service

Source: https://pocketbase.io/docs/going-to-production

Enables and starts the PocketBase systemd service, allowing the application to start/restart on its own.

```bash
[root@dev ~]$ systemctl enable pocketbase.service
[root@dev ~]$ systemctl start pocketbase
```

--------------------------------

### Setup custom API route with superuser auth

Source: https://pocketbase.io/docs/go-testing

Defines a custom API route GET /my/hello that requires superuser authentication using apis.RequireSuperuserAuth(). This is the setup step for the integration test.

```go
// main.go
package main

import (
	"log"
	"net/http"

	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/apis"
	"github.com/pocketbase/pocketbase/core"
)

func bindAppHooks(app core.App) {
	app.OnServe().BindFunc(func(se *core.ServeEvent) error {
		se.Router.Get("/my/hello", func(e *core.RequestEvent) error {
			return e.JSON(http.StatusOK, "Hello world!")
		}).Bind(apis.RequireSuperuserAuth())
		return se.Next()
	})
}

func main() {
	app := pocketbase.New()
	bindAppHooks(app)
	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### Example HTML page with layout - layout.html

Source: https://pocketbase.io/docs/js-rendering-templates

Base template defining placeholders using {{block}} actions. The block actions provide default content that can be overridden by partials. This file is part of the example directory structure with hello.html and main.pb.js.

```html
<!DOCTYPE html>
<html lang="en">
<head>
  <title>{{block "title" .}}Default app title{{end}}</title>
</head>
<body>
    Header...

    {{block "body" .}}
        Default app body...
    {{end}}

    Footer...
</body>
</html>
```

--------------------------------

### Route Registration Examples

Source: https://pocketbase.io/docs/go-routing

Code snippets for registering routes in PocketBase using the router methods.

```APIDOC
## [GET] /hello/{name}

### Description
Registers a GET route that returns a greeting message with the provided name. This route is accessible to everyone.

### Method
GET

### Endpoint
/hello/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name to include in the greeting.

### Response
#### Success Response (200)
- **body** (string) - The greeting message.

#### Response Example
"Hello John"
```

```APIDOC
## [POST] /api/myapp/settings

### Description
Registers a POST route that handles settings updates. This route requires authenticated user access.

### Method
POST

### Endpoint
/api/myapp/settings

### Parameters
#### Request Body
- **success** (boolean) - Required - Indicates the operation success.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates the operation success.

#### Response Example
{
  "success": true
}
```

```APIDOC
## [GET] /api/myapp

### Description
Registers a GET route for the base path of the group. This route requires authenticated user access.

### Method
GET

### Endpoint
/api/myapp

### Response
#### Success Response (200)
- **body** (any) - The response body.
```

```APIDOC
## [GET] /api/myapp/example/{id}

### Description
Registers a GET route for retrieving an example resource by ID. This route requires authenticated user access.

### Method
GET

### Endpoint
/api/myapp/example/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the example resource.

### Response
#### Success Response (200)
- **body** (any) - The response body.
```

```APIDOC
## [PATCH] /api/myapp/example/{id}

### Description
Registers a PATCH route for updating an example resource by ID. This route requires authenticated user access and has a custom route-specific middleware.

### Method
PATCH

### Endpoint
/api/myapp/example/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the example resource.

### Response
#### Success Response (200)
- **body** (any) - The response body.
```

```APIDOC
## [GET] /api/myapp/example/sub/sub1

### Description
Registers a GET route for a nested group path. This route requires authenticated user access.

### Method
GET

### Endpoint
/api/myapp/example/sub/sub1

### Response
#### Success Response (200)
- **body** (any) - The response body.
```

--------------------------------

### Subscribe and unsubscribe with PocketBase SDKs (JavaScript and Dart)

Source: https://pocketbase.io/docs/api-realtime

Use the SDK subscribe and unsubscribe methods to handle realtime subscriptions. The JavaScript example uses the pocketbase npm package, while the Dart example uses the pocketbase Dart package. Both show optional authentication, subscribing to a collection or a single record, and unsubscribing from specific topics or all subscriptions.

```javascript
import PocketBase from 'pocketbase';
const pb = new PocketBase('http://127.0.0.1:8090');
...
// (Optionally) authenticate
await pb.collection('users').authWithPassword('test@example.com', '1234567890');

// Subscribe to changes in any record in the collection
pb.collection('example').subscribe('*', function (e) {
    console.log(e.action);
    console.log(e.record);
}, { /* other options like expand, custom headers, etc. */ });

// Subscribe to changes only in the specified record
pb.collection('example').subscribe('RECORD_ID', function (e) {
    console.log(e.action);
    console.log(e.record);
}, { /* other options like expand, custom headers, etc. */ });

// Unsubscribe
pb.collection('example').unsubscribe('RECORD_ID'); // remove all 'RECORD_ID' subscriptions
pb.collection('example').unsubscribe('*'); // remove all '*' topic subscriptions
pb.collection('example').unsubscribe(); // remove all subscriptions in the collection
```

```dart
import 'package:pocketbase/pocketbase.dart';
final pb = PocketBase('http://127.0.0.1:8090');
...
// (Optionally) authenticate
await pb.collection('users').authWithPassword('test@example.com', '1234567890');

// Subscribe to changes in any record in the collection
pb.collection('example').subscribe('*', (e) {
  print(e.action);
  print(e.record);
}, /* other options like expand, custom headers, etc. */);

// Subscribe to changes only in the specified record
pb.collection('example').subscribe('RECORD_ID', (e) {
  print(e.action);
  print(e.record);
}, /* other options like expand, custom headers, etc. */);

// Unsubscribe
pb.collection('example').unsubscribe('RECORD_ID'); // remove all 'RECORD_ID' subscriptions
pb.collection('example').unsubscribe('*'); // remove all '*' topic subscriptions
pb.collection('example').unsubscribe(); // remove all subscriptions in the collection
```

--------------------------------

### Create a minimal PocketBase app with static file serving

Source: https://pocketbase.io/docs/go-overview

Minimal PocketBase application that creates a new instance with pocketbase.New(), registers a static file server for the ./pb_public directory via the OnServe hook, and starts the app with app.Start(). Requires Go 1.23+ and the PocketBase package. Run with `go run . serve` after initializing dependencies with `go mod init myapp && go mod tidy`.

```go
package main

import (
	"log"
	"os"

	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/apis"
	"github.com/pocketbase/pocketbase/core"
)

func main() {
	app := pocketbase.New()

	app.OnServe().BindFunc(func(se *core.ServeEvent) error {
		// serves static files from the provided public dir (if exists)
		se.Router.GET("/{path...}", apis.Static(os.DirFS("./pb_public"), false))
		return se.Next()
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### List settings with pb.settings.getAll()

Source: https://pocketbase.io/docs/api-settings

Retrieves all application settings after authenticating as a superuser. Secret fields are redacted with ****** in the response. Only superusers can perform this action.

```JavaScript
import PocketBase from 'pocketbase';
const pb = new PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '1234567890');
const settings = await pb.settings.getAll();
```

```Dart
import 'package:pocketbase/pocketbase.dart';
final pb = PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '1234567890');
final settings = await pb.settings.getAll();
```

--------------------------------

### GET /api/crons 403 error response

Source: https://pocketbase.io/docs/api-crons

Example 403 error response for GET /api/crons.

```JSON
{ "status": 403, "message": "Only superusers can perform this action.", "data": {} }
```

--------------------------------

### GET /api/crons 400 error response

Source: https://pocketbase.io/docs/api-crons

Example 400 error response for GET /api/crons.

```JSON
{ "status": 400, "message": "Failed to load backups filesystem.", "data": {} }
```

--------------------------------

### app.NewFilesystem()

Source: https://pocketbase.io/docs/go-filesystem

Initializes a new filesystem instance for file operations. Must be closed with Close() after use.

```APIDOC
## app.NewFilesystem()

### Description
Initializes a new filesystem instance for file operations. Must be closed with Close() after use.

### Method
NewFilesystem

### Endpoint
app.NewFilesystem()

### Parameters
None

### Request Example
```go
fsys, err := app.NewFilesystem()
if err != nil {
    return err
}
defer fsys.Close()
```

### Response
#### Success Response
- **fsys** (*Filesystem) - The filesystem instance.
- **err** (error) - Error if initialization fails.

#### Response Example
```go
fsys, err := app.NewFilesystem()
```
```

--------------------------------

### GET /api/settings 403 response

Source: https://pocketbase.io/docs/api-settings

Example 403 response for GET /api/settings when the authorized record is not allowed to perform the action.

```JSON
{ "status": 403, "message": "The authorized record is not allowed to perform this action.", "data": {} }
```

--------------------------------

### GET /api/settings 401 response

Source: https://pocketbase.io/docs/api-settings

Example 401 response for GET /api/settings when the request lacks a valid authorization token.

```JSON
{ "status": 401, "message": "The request requires valid record authorization token.", "data": {} }
```

--------------------------------

### OnSettingsReload hook example

Source: https://pocketbase.io/docs/go-event-hooks

Registers a handler for the OnSettingsReload hook, triggered every time App.Settings() is replaced with a new state. Calling e.App.Settings() after e.Next() returns the new state.

```go
package main

import (
	"log"

	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/core"
)

func main() {
	app := pocketbase.New()

	app.OnSettingsReload().BindFunc(func(e *core.SettingsReloadEvent) error {
		if err := e.Next(); err != nil {
			return err
		}
		// e.App.Settings()
		return nil
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### GET /api/settings 200 response

Source: https://pocketbase.io/docs/api-settings

Example 200 response for GET /api/settings. Shows the full settings object with redacted secret fields.

```JSON
{ "smtp": { "enabled": false, "port": 587, "host": "smtp.example.com", "username": "", "authMethod": "", "tls": true, "localName": "" }, "backups": { "cron": "0 0 * * *", "cronMaxKeep": 3, "s3": { "enabled": false, "bucket": "", "region": "", "endpoint": "", "accessKey": "", "forcePathStyle": false } }, "s3": { "enabled": false, "bucket": "", "region": "", "endpoint": "", "accessKey": "", "forcePathStyle": false }, "meta": { "appName": "Acme", "appURL": "https://example.com", "senderName": "Support", "senderAddress": "support@example.com", "hideControls": false }, "rateLimits": { "rules": [ { "label": "*:auth", "audience": "", "duration": 3, "maxRequests": 2 }, { "label": "*:create", "audience": "", "duration": 5, "maxRequests": 20 }, { "label": "/api/batch", "audience": "", "duration": 1, "maxRequests": 3 }, { "label": "/api/", "audience": "", "duration": 10, "maxRequests": 300 } ], "enabled": false }, "trustedProxy": { "headers": [], "useLeftmostIP": false }, "batch": { "enabled": true, "maxRequests": 50, "timeout": 3, "maxBodySize": 0 }, "logs": { "maxDays": 7, "minLevel": 0, "logIP": true, "logAuthId": false } }
```

--------------------------------

### GET /api/crons 200 response

Source: https://pocketbase.io/docs/api-crons

Example 200 response for GET /api/crons. Returns a list of cron job objects with id and expression fields.

```JSON
[ { "id": "__pbDBOptimize__", "expression": "0 0 * * *" }, { "id": "__pbMFACleanup__", "expression": "0 * * * *" }, { "id": "__pbOTPCleanup__", "expression": "0 * * * *" }, { "id": "__pbLogsCleanup__", "expression": "0 */6 * * *" } ]
```

--------------------------------

### Register middlewares with Id, Priority, and execution order

Source: https://pocketbase.io/docs/go-routing

Shows all middleware options (Id, Priority, Func) and the execution order for global, group, and route middlewares. The expected sequence for "GET /sub/hello" is 2,0,1,3,4.

```go
app.OnServe().BindFunc(func(se *core.ServeEvent) error {
    // attach global middleware
    se.Router.BindFunc(func(e *core.RequestEvent) error {
        println(0)
        return e.Next()
    })

    g := se.Router.Group("/sub")

    // attach group middleware
    g.BindFunc(func(e *core.RequestEvent) error {
        println(1)
        return e.Next()
    })

    // attach group middleware with an id and custom priority
    g.Bind(&hook.Handler[*core.RequestEvent]{
        Id:       "something",
        Func:     func(e *core.RequestEvent) error {
            println(2)
            return e.Next()
        },
        Priority: -1,
    })

    // attach middleware to a single route
    //
    // "GET /sub/hello" should print the sequence: 2,0,1,3,4
    g.GET("/hello", func(e *core.RequestEvent) error {
        println(4)
        return e.String(200, "Hello!")
    }).BindFunc(func(e *core.RequestEvent) error {
        println(3)
        return e.Next()
    })

    return se.Next()
})
```

--------------------------------

### Create route group with shared middleware and nested group

Source: https://pocketbase.io/docs/go-routing

Creates a route group with a shared base path and middleware. The group binds apis.RequireAuth() to all routes, and supports nested groups. The example registers endpoints: GET /api/myapp, GET /api/myapp/example/{id}, PATCH /api/myapp/example/{id}, and GET /api/myapp/example/sub/sub1, all requiring authenticated user access.

```go
g := se.Router.Group("/api/myapp")

// group middleware
g.Bind(apis.RequireAuth())

// group routes
g.GET("", action1)
g.GET("/example/{id}", action2)
g.PATCH("/example/{id}", action3).BindFunc( /* custom route specific middleware func */ )

// nested group
sub := g.Group("/sub")
sub.GET("/sub1", action4)
```

--------------------------------

### GET /api/logs

Source: https://pocketbase.io/docs/api-logs

This snippet documents the API endpoint for listing logs, which is accessible only to superusers. It includes the HTTP method, endpoint, query parameters, and a response example.

```APIDOC
## [GET] /api/logs

### Description
Returns a paginated logs list. Only superusers can perform this action.

### Method
GET

### Endpoint
/api/logs

### Parameters
#### Query Parameters
- **page** (number) - Required - The page number to retrieve.
- **perPage** (number) - Required - The number of logs per page.
- **filter** (string) - Optional - Filter expression to narrow down the logs, e.g., `data.status >= 400`.

### Request Example
```
GET /api/logs?page=1&perPage=20&filter=data.status%20%3E%3D%20400
```

### Response
#### Success Response (200)
- **page** (number) - The current page number.
- **perPage** (number) - The number of logs per page.
- **totalItems** (number) - The total number of logs matching the filter.
- **totalPages** (number) - The total number of pages.
- **items** (array) - The list of log entries.

#### Response Example
```json
{
  "page": 1,
  "perPage": 20,
  "totalItems": 1,
  "totalPages": 1,
  "items": [
    {
      "id": "log_id",
      "data": {
        "status": 400
      }
    }
  ]
}
```
```

--------------------------------

### Get collection scaffolds - Dart SDK

Source: https://pocketbase.io/docs/api-collections

Returns an object with all collection types and their default fields, used primarily in the Dashboard UI. Only superusers can perform this action. The example authenticates as a superuser and retrieves the scaffolds.

```dart
import 'package:pocketbase/pocketbase.dart';
final pb = PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '1234567890');
final scaffolds = await pb.collections.getScaffolds();
```

--------------------------------

### OnBootstrap hook example

Source: https://pocketbase.io/docs/go-event-hooks

Registers a handler for the OnBootstrap hook, which fires when initializing main app resources (db, settings, etc.). Accessing the database before calling e.Next() results in an error.

```go
package main

import (
	"log"

	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/core"
)

func main() {
	app := pocketbase.New()

	app.OnBootstrap().BindFunc(func(e *core.BootstrapEvent) error {
		if err := e.Next(); err != nil {
			return err
		}
		// e.App
		return nil
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### Get collection scaffolds - JavaScript SDK

Source: https://pocketbase.io/docs/api-collections

Returns an object with all collection types and their default fields, used primarily in the Dashboard UI. Only superusers can perform this action. The example authenticates as a superuser and retrieves the scaffolds.

```javascript
import PocketBase from 'pocketbase';
const pb = new PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '1234567890');
const scaffolds = await pb.collections.getScaffolds();
```

--------------------------------

### Set up and use a global superuser client in PocketBase

Source: https://pocketbase.io/docs/how-to-use

Create a global superuser client in a separate module and import it in server-side actions to interact with PocketBase as a superuser. The first block shows authentication via email/password or a long-lived API key, with autoCancellation disabled and autoRefreshThreshold set. The second block demonstrates importing and using that client to send a create request.

```javascript
// src/superuser.js
import PocketBase from "pocketbase"

const superuserClient = new PocketBase('https://example.com');

// disable autocancellation so that we can handle async requests from multiple users
superuserClient.autoCancellation(false);

// option 1: authenticate as superuser using email/password (could be filled with ENV params)
await superuserClient.collection('_superusers').authWithPassword(SUPERUSER_EMAIL, SUPERUSER_PASS, {
  // This will trigger auto refresh or auto reauthentication in case
  // the token has expired or is going to expire in the next 30 minutes.
  autoRefreshThreshold: 30 * 60
})

// option 2: OR authenticate as superuser via long-lived "API key"
// (see https://pocketbase.io/docs/authentication/#api-keys)
superuserClient.authStore.save('YOUR_GENERATED_SUPERUSER_TOKEN')

export default superuserClient;
```

```javascript
import superuserClient from './src/superuser.js'

async function serverAction(req, resp) {
  ... do some extra data validations or handling ...

  // send a create request as superuser
  await superuserClient.collection('example').create({
    ...
  })
}
```

--------------------------------

### Register custom route to render hello page

Source: https://pocketbase.io/docs/js-rendering-templates

Registers a GET route /hello/{name} that loads layout.html and hello.html, renders them with the name from the request path, and returns the HTML response. This is the final step in the example workflow.

```javascript
routerAdd("get", "/hello/{name}", (e) => {
  const name = e.request.pathValue("name")
  const html = $template.loadFiles(
    `${__hooks}/views/layout.html`,
    `${__hooks}/views/hello.html`,
  ).render({
    "name": name,
  })
  return e.html(200, html)
})
```

--------------------------------

### Register custom console command (Go and JavaScript)

Source: https://pocketbase.io/docs/use-as-framework

Register a custom console command named "hello" that prints "Hello world!". The Go version uses app.RootCmd.AddCommand with a cobra.Command; the JavaScript version uses $app.rootCmd.addCommand with a Command. Both are shown as equivalent alternatives in the source.

```go
app.RootCmd.AddCommand(&cobra.Command{
    Use: "hello",
    Run: func(cmd *cobra.Command, args []string) {
        print("Hello world!")
    },
})
```

```javascript
$app.rootCmd.addCommand(new Command({
    use: "hello",
    run: (cmd, args) => {
        console.log("Hello world!")
    },
}))
```

--------------------------------

### Get logs statistics in Dart

Source: https://pocketbase.io/docs/api-logs

Dart example for retrieving hourly aggregated logs statistics. Requires superuser authentication via the _superusers collection. The filter parameter is optional and can be used to filter logs, e.g., by status code.

```dart
import 'package:pocketbase/pocketbase.dart';
final pb = PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '123456');
final stats = await pb.logs.getStats(
    filter: 'data.status >= 400'
);
```

--------------------------------

### Get logs statistics in JavaScript

Source: https://pocketbase.io/docs/api-logs

JavaScript example for retrieving hourly aggregated logs statistics. Requires superuser authentication via the _superusers collection. The filter parameter is optional and can be used to filter logs, e.g., by status code.

```javascript
import PocketBase from 'pocketbase';
const pb = new PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '123456');
const stats = await pb.logs.getStats({ filter: 'data.status >= 400' });
```

--------------------------------

### Update settings with pb.settings.update()

Source: https://pocketbase.io/docs/api-settings

Bulk updates application settings and returns the updated settings list. Only superusers can perform this action. The example updates the meta.appName and meta.appUrl fields.

```JavaScript
import PocketBase from 'pocketbase';
const pb = new PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '123456');
const settings = await pb.settings.update({ meta: { appName: 'YOUR_APP', appUrl: 'http://127.0.0.1:8090', }, });
```

```Dart
import 'package:pocketbase/pocketbase.dart';
final pb = PocketBase('http://127.0.0.1:8090');
...
await pb.collection("_superusers").authWithPassword('test@example.com', '123456');
final settings = await pb.settings.update(body: { 'meta': { 'appName': 'YOUR_APP', 'appUrl': 'http://127.0.0.1:8090', }, });
```

--------------------------------

### GET /api/collections/meta/scaffolds - Success Response

Source: https://pocketbase.io/docs/api-collections

Example 200 response containing the scaffold definitions for auth, base, and view collection types. The auth scaffold includes fields like id, password, tokenKey, email, emailVisibility, and verified, along with indexes and various token and template settings.

```json
{ "auth": { "id": "", "listRule": null, "viewRule": null, "createRule": null, "updateRule": null, "deleteRule": null, "name": "", "type": "auth", "fields": [ { "autogeneratePattern": "[a-z0-9]{15}", "hidden": false, "id": "text3208210256", "max": 15, "min": 15, "name": "id", "pattern": "^[a-z0-9]+$", "presentable": false, "primaryKey": true, "required": true, "system": true, "type": "text" }, { "cost": 0, "hidden": true, "id": "password901924565", "max": 0, "min": 8, "name": "password", "pattern": "", "presentable": false, "required": true, "system": true, "type": "password" }, { "autogeneratePattern": "[a-zA-Z0-9]{50}", "hidden": true, "id": "text2504183744", "max": 60, "min": 30, "name": "tokenKey", "pattern": "", "presentable": false, "primaryKey": false, "required": true, "system": true, "type": "text" }, { "exceptDomains": null, "hidden": false, "id": "email3885137012", "name": "email", "onlyDomains": null, "presentable": false, "required": true, "system": true, "type": "email" }, { "hidden": false, "id": "bool1547992806", "name": "emailVisibility", "presentable": false, "required": false, "system": true, "type": "bool" }, { "hidden": false, "id": "bool256245529", "name": "verified", "presentable": false, "required": false, "system": true, "type": "bool" } ], "indexes": [ "CREATE UNIQUE INDEX `idx_tokenKey_hclGvwhtqG` ON `test` (`tokenKey`)", "CREATE UNIQUE INDEX `idx_email_eyxYyd3gp1` ON `test` (`email`) WHERE `email` != ''" ], "created": "", "updated": "", "system": false, "authRule": "", "manageRule": null, "authAlert": { "enabled": true, "emailTemplate": { "subject": "Login from a new location", "body": "..." } }, "oauth2": { "providers": [], "mappedFields": { "id": "", "name": "", "username": "", "avatarURL": "" }, "enabled": false }, "passwordAuth": { "enabled": true, "identityFields": [ "email" ] }, "mfa": { "enabled": false, "duration": 1800, "rule": "" }, "otp": { "enabled": false, "duration": 180, "length": 8, "emailTemplate": { "subject": "OTP for {APP_NAME}", "body": "..." } }, "authToken": { "duration": 604800 }, "passwordResetToken": { "duration": 1800 }, "emailChangeToken": { "duration": 1800 }, "verificationToken": { "duration": 259200 }, "fileToken": { "duration": 180 }, "verificationTemplate": { "subject": "Verify your {APP_NAME} email", "body": "..." }, "resetPasswordTemplate": { "subject": "Reset your {APP_NAME} password", "body": "..." }, "confirmEmailChangeTemplate": { "subject": "Confirm your {APP_NAME} new email address", "body": "..." } }, "base": { "id": "", "listRule": null, "viewRule": null, "createRule": null, "updateRule": null, "deleteRule": null, "name": "", "type": "base", "fields": [ { "autogeneratePattern": "[a-z0-9]{15}", "hidden": false, "id": "text3208210256", "max": 15, "min": 15, "name": "id", "pattern": "^[a-z0-9]+$", "presentable": false, "primaryKey": true, "required": true, "system": true, "type": "text" } ], "indexes": [], "created": "", "updated": "", "system": false }, "view": { "id": "", "listRule": null, "viewRule": null, "createRule": null, "updateRule": null, "deleteRule": null, "name": "", "type": "view", "fields": [], "indexes": [], "created": "", "updated": "", "system": false, "viewQuery": "" } }
```

--------------------------------

### Serve static directory with apis.Static

Source: https://pocketbase.io/docs/go-routing

apis.Static() serves static directory content from an fs.FS instance. Expects the route to have a {path...} wildcard parameter. The second argument false likely disables listing or similar; the example serves from /path/to/public.

```go
app.OnServe().BindFunc(func(se *core.ServeEvent) error {
    // serves static files from the provided dir (if exists)
    se.Router.GET("/{path...}", apis.Static(os.DirFS("/path/to/public"), false))
    return se.Next()
})
```

--------------------------------

### Register custom console command with app.rootCmd.addCommand

Source: https://pocketbase.io/docs/js-console-commands

Registers a custom console command named "hello" that prints "Hello world!". Run it with ./pocketbase hello. Console commands execute in their own separate app process, independent from the main serve command, so hook and realtime events are not shared between processes.

```javascript
$app.rootCmd.addCommand(new Command({
    use: "hello",
    run: (cmd, args) => {
        console.log("Hello world!")
    },
}))
```

```bash
./pocketbase hello
```

--------------------------------

### $app.db().select()

Source: https://pocketbase.io/docs/js-database

Initializes a SELECT query builder. Accepts a list of column names to be selected.

```APIDOC
## $app.db().select()

### Description
Initializes a SELECT query builder. Accepts a list of column names to be selected. Additional columns can be added with andSelect(), and distinct rows can be selected with distinct(true).

### Method
Not applicable (JavaScript SDK method)

### Endpoint
Not applicable

### Parameters
#### Query Parameters
- **cols** (string[]) - Required - List of column names to select.

### Request Example
```javascript
$app.db()
  .select("id", "avatar as image")
  .andSelect("(firstName || ' ' || lastName) as fullName")
  .distinct(true)
  ...
```

### Response
Returns the query builder for chaining.
```

--------------------------------

### POST /api/collections/{collectionIdOrName}/auth-with-password - Example Response

Source: https://pocketbase.io/docs/api-records

Example 200 response containing a JWT token and the authenticated record data.

```json
{ "token": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjRxMXhsY2xtZmxva3UzMyIsInR5cGUiOiJhdXRoUmVjb3JkIiwiY29sbGVjdGlvbklkIjoiX3BiX3VzZXJzX2F1dGhfIiwiZXhwIjoyMjA4OTg1MjYxfQ.UwD8JvkbQtXpymT09d7J6fdA0aP9g4FJ1GPh_ggEkzc", "record": { "id": "8171022dc95a4ed", "collectionId": "d2972397d45614e", "collectionName": "users", "created": "2022-06-24 06:24:18.434Z", "updated": "2022-06-24 06:24:18.889Z", "username": "test@example.com", "email": "test@example.com", "verified": false, "emailVisibility": true, "someCustomField": "example 123" } }
```

--------------------------------

### List OAuth2 providers: GET /api/collections/meta/oauth2-providers

Source: https://pocketbase.io/docs/api-collections

GET request to list all configurable OAuth2 providers. Requires an Authorization token and superuser permissions.

```http
GET /api/collections/meta/oauth2-providers
```

--------------------------------

### Register middlewares with priority and route-specific middleware

Source: https://pocketbase.io/docs/js-routing

Shows all middleware registration options: simple function, Middleware class with custom priority, and route-specific middleware. The expected execution sequence for GET /hello is 2,1,3,4.

```javascript
// attach global middleware
routerUse((e) => {
    console.log(1)
    return e.next()
})

// attach global middleware with a custom priority
routerUse(new Middleware((e) => {
  console.log(2)
  return e.next()
}, -1))

// attach middleware to a single route
//
// "GET /hello" should print the sequence: 2,1,3,4
routerAdd("GET", "/hello", (e) => {
    console.log(4)
    return e.string(200, "Hello!")
}, (e) => {
    console.log(3)
    return e.next()
})
```

--------------------------------

### Expanded response example

Source: https://pocketbase.io/docs/working-with-relations

Example JSON response from a getList request with the 'user' relation expanded. Shows the structure of the 'expand' field containing the related record.

```JSON
{
  "page": 1,
  "perPage": 30,
  "totalPages": 1,
  "totalItems": 20,
  "items": [
    {
      "id": "lmPJt4Z9CkLW36z",
      "collectionId": "BHKW36mJl3ZPt6z",
      "collectionName": "comments",
      "created": "2022-01-01 01:00:00.456Z",
      "updated": "2022-01-01 02:15:00.456Z",
      "post": "WyAw4bDrvws6gGl",
      "user": "FtHAW9feB5rze7D",
      "message": "Example message...",
      "expand": {
        "user": {
          "id": "FtHAW9feB5rze7D",
          "collectionId": "srmAo0hLxEqYF7F",
          "collectionName": "users",
          "created": "2022-01-01 00:00:00.000Z",
          "updated": "2022-01-01 00:00:00.000Z",
          "username": "users54126",
          "verified": false,
          "emailVisibility": false,
          "name": "John Doe"
        }
      }
    },
    ...
  ]
}
```

--------------------------------

### Create a new migration with migrate create

Source: https://pocketbase.io/docs/js-migrations

Creates a new blank migration file in the pb_migrations directory. The generated file contains a migrate() call with up and down callbacks; the down callback is optional and both receive a transactional app instance. New migrations are applied automatically on serve.

```bash
[root@dev app]$ ./pocketbase migrate create "your_new_migration"
```

```javascript
// pb_migrations/1687801097_your_new_migration.js migrate((app) => { // add up queries... }, (app) => { // add down queries... })
```

--------------------------------

### OnBootstrap

Source: https://pocketbase.io/docs/go-event-hooks

Hook triggered when initializing the main application resources (db, app settings, etc.).

```APIDOC
## OnBootstrap

### Description
Triggered when initializing the main application resources (db, app settings, etc.). Attempting to access the database before the `e.Next()` call will result in an error.

### Method
Hook

### Event
`core.BootstrapEvent`

### Usage
```go
package main

import (
	"log"
	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/core"
)

func main() {
	app := pocketbase.New()

	app.OnBootstrap().BindFunc(func(e *core.BootstrapEvent) error {
		if err := e.Next(); err != nil {
			return err
		}
		// e.App
		return nil
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```
```

--------------------------------

### onRecordValidate hook examples

Source: https://pocketbase.io/docs/js-event-hooks

Triggered every time a Record is being validated, e.g. by $app.validate() or $app.save(). The first example fires for every record, the second fires only for 'users' and 'articles' records.

```javascript
// fires for every record
onRecordValidate((e) => {
  // e.app
  // e.record

  e.next()
})
```

```javascript
// fires only for "users" and "articles" records
onRecordValidate((e) => {
  // e.app
  // e.record

  e.next()
}, "users", "articles")
```

--------------------------------

### Register custom route (Go and JavaScript)

Source: https://pocketbase.io/docs/use-as-framework

Register a custom route that responds with "Hello world!" on GET /hello. The Go version uses app.OnServe().BindFunc and core.ServeEvent; the JavaScript version uses routerAdd. Both are shown as equivalent alternatives in the source.

```go
app.OnServe().BindFunc(func(se *core.ServeEvent) error {
    se.Router.GET("/hello", func(e *core.RequestEvent) error {
        return e.String(http.StatusOK, "Hello world!")
    })
    return se.Next()
})
```

```javascript
routerAdd("GET", "/hello", (e) => {
    return e.string(200, "Hello world!")
})
```

--------------------------------

### OnSettingsReload

Source: https://pocketbase.io/docs/go-event-hooks

Hook triggered every time when the `App.Settings()` is being replaced with a new state.

```APIDOC
## OnSettingsReload

### Description
Triggered every time when the `App.Settings()` is being replaced with a new state. Calling `e.App.Settings()` after `e.Next()` returns the new state.

### Method
Hook

### Event
`core.SettingsReloadEvent`

### Usage
```go
package main

import (
	"log"
	"github.com/pocketbase/pocketbase"
	"github.com/pocketbase/pocketbase/core"
)

func main() {
	app := pocketbase.New()

	app.OnSettingsReload().BindFunc(func(e *core.SettingsReloadEvent) error {
		if err := e.Next(); err != nil {
			return err
		}
		// e.App.Settings()
		return nil
	})

	if err := app.Start(); err != nil {
		log.Fatal(err)
	}
}
```
```
Tokens:
Raw