Read Records

Phi provides three methods for reading records:

FindUnique
FindFirst
FindMany

All three methods support the same predicate system and share the same selection API.

Note: Every predicate passed to a query method is combined with AND in the compiled SQL. To build more complex boolean logic, bundle conditions together with And, Or, or Not.

FindUnique

Retrieves a single record by a required unique predicate. The additional predicates passed after the first argument are ANDed into the query:

Examples

user, err := db.User.
    FindUnique(
        user.Email.EQ("x@y.com"),
    ).
    Exec(ctx)

user, err := db.User.
    FindUnique(
        user.Email.EQ("x@y.com"),
        user.Bio.Contains("the"),
    ).
    Exec(ctx)

user, err := db.User.
    FindUnique(
        user.Email.EQ("x@y.com"),
        user.Or(
            user.Bio.Contains("the"),
            user.PhoneNum.HasPrefix("+1"),
        ),
    ).
    Exec(ctx)

Supported Builder Methods

Method	Description
`Select`	Select specific fields and relations.
`Omit`	Omit specific scalar fields.

FindFirst

Retrieves the first record that satisfies all supplied predicates.

Examples

user, err := db.User.
    FindFirst(
        user.Email.EQ("x@y.com"),
    ).
    Exec(ctx)

user, err := db.User.
    FindFirst(
        user.Email.EQ("x@y.com"),
        user.Bio.Contains("the"),
    ).
    Exec(ctx)

user, err := db.User.
    FindFirst(
        user.Email.EQ("x@y.com"),
        user.Or(
            user.Bio.Contains("the"),
            user.PhoneNum.HasPrefix("+1"),
        ),
    ).
    Exec(ctx)

Supported Builder Methods

Method	Description
`Select`	Select specific fields and relations.
`Omit`	Omit specific scalar fields.
`Skip`	Skip a number of matching records. Mirrors SQL's `OFFSET`.
`Take`	Limit the number of returned records. Mirrors SQL's `LIMIT`.
`OrderBy`	Specify the ordering of results. Mirrors SQL's `ORDER BY`.
`Cursor`	Continue querying from a specific cursor.

FindMany

Retrieves all records that satisfy all supplied predicates.

Examples

users, err := db.User.
    FindMany(
        user.Email.EQ("x@y.com"),
    ).
    Exec(ctx)

users, err := db.User.
    FindMany(
        user.Email.EQ("x@y.com"),
        user.Bio.Contains("the"),
    ).
    Exec(ctx)

users, err := db.User.
    FindMany(
        user.Email.EQ("x@y.com"),
        user.Or(
            user.Bio.Contains("the"),
            user.PhoneNum.HasPrefix("+1"),
        ),
    ).
    Exec(ctx)

Supported Builder Methods

Method	Description
`Select`	Select specific fields and relations.
`Omit`	Omit specific scalar fields.
`Skip`	Skip a number of matching records. Mirrors SQL's `OFFSET`.
`Take`	Limit the number of returned records. Mirrors SQL's `LIMIT`.
`OrderBy`	Specify the ordering of results. Mirrors SQL's `ORDER BY`.
`Cursor`	Continue querying from a specific cursor.