Bool

The boolean type represents true/false values with simple, focused filter operations.

Overview

Property	Value
Go Type	bool / *bool
Database Schema	bool / option<bool>
CBOR Encoding	Direct
Sortable	Yes

Definition

type User struct {
    som.Node

    IsActive    bool   // Required
    IsAdmin     bool   // Required
    IsVerified  *bool  // Optional (nullable)
}

Schema

Generated SurrealDB schema:

DEFINE FIELD is_active ON user TYPE bool;
DEFINE FIELD is_admin ON user TYPE bool;
DEFINE FIELD is_verified ON user TYPE option<bool>;

Filter Operations

Value Check

// Check specific value
filter.User.IsActive.Is(true)
filter.User.IsAdmin.Is(false)

Convenience Methods

// Check if true
filter.User.IsActive.True()

// Check if false
filter.User.IsAdmin.False()

Logical Inversion

// Invert the boolean
filter.User.IsActive.Invert().True()  // Same as Is(false)

Nil Operations (Pointer Types Only)

// Check if nil
filter.User.IsVerified.IsNil()

// Check if not nil
filter.User.IsVerified.IsNotNil()

Sorting

Boolean fields sort with false before true in ascending order:

// Ascending (false, then true)
query.Order(by.User.IsActive.Asc())

// Descending (true, then false)
query.Order(by.User.IsActive.Desc())

// Common pattern: active users first
query.Order(
    by.User.IsActive.Desc(),  // Active first
    by.User.Name.Asc(),       // Then alphabetical
)

Method Chaining

Boolean filters can be inverted:

// Find inactive users
filter.User.IsActive.Invert().True()

// Equivalent to
filter.User.IsActive.False()
filter.User.IsActive.Is(false)

Common Patterns

Combining Boolean Filters

// Active admin users
users, _ := client.UserRepo().Query().
    Where(
        filter.User.IsActive.True(),
        filter.User.IsAdmin.True(),
    ).
    All(ctx)

OR Logic with Booleans

// Active OR admin users
users, _ := client.UserRepo().Query().
    Where(
        filter.Any(
            filter.User.IsActive.True(),
            filter.User.IsAdmin.True(),
        ),
    ).
    All(ctx)

Optional Boolean Handling

// Users with verified status set
verifiedSet, _ := client.UserRepo().Query().
    Where(filter.User.IsVerified.IsNotNil()).
    All(ctx)

// Users explicitly verified
verified, _ := client.UserRepo().Query().
    Where(
        filter.User.IsVerified.IsNotNil(),
        filter.User.IsVerified.True(),
    ).
    All(ctx)

// Users not verified (either false or null)
notVerified, _ := client.UserRepo().Query().
    Where(
        filter.Any(
            filter.User.IsVerified.IsNil(),
            filter.User.IsVerified.False(),
        ),
    ).
    All(ctx)

Complete Example

package main

import (
    "context"
    "yourproject/gen/som"
    "yourproject/gen/som/by"
    "yourproject/gen/som/filter"
)

func main() {
    ctx := context.Background()
    client, _ := som.NewClient(ctx, som.Config{...})

    // Find active users
    activeUsers, _ := client.UserRepo().Query().
        Where(filter.User.IsActive.True()).
        All(ctx)

    // Find inactive non-admin users
    inactiveNonAdmins, _ := client.UserRepo().Query().
        Where(
            filter.User.IsActive.False(),
            filter.User.IsAdmin.False(),
        ).
        All(ctx)

    // Count admins
    adminCount, _ := client.UserRepo().Query().
        Where(filter.User.IsAdmin.True()).
        Count(ctx)

    // Check if any unverified users exist
    hasUnverified, _ := client.UserRepo().Query().
        Where(
            filter.Any(
                filter.User.IsVerified.IsNil(),
                filter.User.IsVerified.False(),
            ),
        ).
        Exists(ctx)

    // Get users sorted by status
    sorted, _ := client.UserRepo().Query().
        Order(
            by.User.IsAdmin.Desc(),   // Admins first
            by.User.IsActive.Desc(),  // Then active
            by.User.Name.Asc(),       // Then alphabetical
        ).
        All(ctx)
}

Filter Reference Table

Operation	Description	Returns
Is(val)	Check boolean value	Bool filter
True()	Check if true	Bool filter
False()	Check if false	Bool filter
Invert()	Logical NOT	Bool filter
IsNil()	Is null (ptr only)	Bool filter
IsNotNil()	Not null (ptr only)	Bool filter