sqlpipe

package
v0.0.0-...-0d8370d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2025 License: MIT Imports: 12 Imported by: 4

Documentation

Overview

Inspired by Pipe-Syntax-In-SQL https://static.simonwillison.net/static/2024/Pipe-Syntax-In-SQL.html +gengo:runtimedoc=false

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Columns 

func Columns[M Model](cols ...modelscoped.Column[M]) iter.Seq[modelscoped.Column[M]]

func NoWait 

func NoWait() func(LockOption)

func SkipLocked 

func SkipLocked() func(LockOption)

Types

type Embed 

type Embed[M Model] struct {
	Underlying Source[M]
}

func (*Embed[M]) GetFlag 

func (u *Embed[M]) GetFlag(ctx context.Context) flags.Flag

func (*Embed[M]) IsNil 

func (e *Embed[M]) IsNil() bool

func (*Embed[M]) Unwrap 

func (u *Embed[M]) Unwrap() Source[M]

type Filter 

type Filter[M Model] interface {
	sqlfrag.Fragment
}

type FilterOp 

type FilterOp uint8
const (
	FilterOpAnd FilterOp = iota
	FilterOpOr
)

type FromPatcher 

type FromPatcher[M Model] interface {
	ApplyToFrom(s SourceCanPatcher[M])
}

type LimitOption 

type LimitOption interface {
	SetOffset(offset int64)
}

type LimitOptionFunc 

type LimitOptionFunc = func(o LimitOption)

func Offset 

func Offset(offset int64) LimitOptionFunc

type LockOption 

type LockOption interface {
	SetOnLockConflict(onLockConflict OnLockConflict)
}

type Model 

type Model = sqlbuilder.Model

type ModelNewer 

type ModelNewer[M Model] sqlbuilder.ModelNewer[M]

type OnLockConflict 

type OnLockConflict uint8
const (
	OnLockConflictWait OnLockConflict = iota
	OnLockConflictNoWait
	OnLockConflictSkipLocked
)

type OperatorType 

type OperatorType uint
const (
	OperatorCompose OperatorType = iota
	OperatorProject
	OperatorFilter
	OperatorSort
	OperatorLimit
	OperatorLock
	OperatorOnConflict
	OperatorJoin
	OperatorCommit
	OperatorSetting
)

type P 

type P struct{}

type Source 

type Source[M Model] interface {
	Pipe(operators ...SourceOperator[M]) Source[M]

	sqlfrag.Fragment

	internal.StmtPatcher[M]
}

func Aggregate 

func Aggregate[S Model, O Model](src Source[S], cols ...modelscoped.Column[O]) Source[O]

func AggregateGroupBy 

func AggregateGroupBy[S Model, O Model](src Source[S], by iter.Seq[modelscoped.Column[S]], cols ...modelscoped.Column[O]) Source[O]

func As 

func As[M Model](src Source[M], name string, opts ...FromPatcher[M]) Source[M]

func From 

func From[M Model](patchers ...FromPatcher[M]) Source[M]

func FromAll 

func FromAll[M Model](patchers ...FromPatcher[M]) Source[M]

func InsertFrom 

func InsertFrom[S Model, O Model](src Source[S], cols ...modelscoped.Column[O]) Source[O]

func Pipe 

func Pipe[M Model](src Source[M], operators ...SourceOperator[M]) Source[M]

func Value 

func Value[M Model](value *M, columns ...modelscoped.Column[M]) Source[M]

func ValueOmit 

func ValueOmit[M Model](value *M, columns ...modelscoped.Column[M]) Source[M]

func ValueOmitZero 

func ValueOmitZero[M Model](value *M, exclude ...modelscoped.Column[M]) Source[M]

func ValueSeq 

func ValueSeq[M Model](values iter.Seq[*M], strictColumns ...modelscoped.Column[M]) Source[M]

func ValueSeqOmit 

func ValueSeqOmit[M Model](values iter.Seq[*M], columns ...modelscoped.Column[M]) Source[M]

func Values 

func Values[Slice ~[]*M, M Model](values Slice, strictColumns ...modelscoped.Column[M]) Source[M]

func ValuesOmit 

func ValuesOmit[Slice ~[]*M, M Model](values Slice, columns ...modelscoped.Column[M]) Source[M]

type SourceCanPatcher 

type SourceCanPatcher[M Model] interface {
	AddPatchers(patchers ...internal.StmtPatcher[M])
}

type SourceOperator 

type SourceOperator[M Model] interface {
	internal.Operator[Source[M], Source[M]]

	OperatorType() OperatorType
}

func AscSort 

func AscSort[M Model](col modelscoped.Column[M], ex ...sqlfrag.Fragment) SourceOperator[M]

func CastAscSort 

func CastAscSort[M Model, U Model](col modelscoped.Column[U], ex ...sqlfrag.Fragment) SourceOperator[M]

func CastDescSort 

func CastDescSort[M Model, U Model](col modelscoped.Column[U], ex ...sqlfrag.Fragment) SourceOperator[M]

func CastOrWhere 

func CastOrWhere[M Model, U Model, T comparable](col modelscoped.TypedColumn[U, T], valuer sqlbuilder.ColumnValuer[T]) SourceOperator[M]

func CastSelect 

func CastSelect[M Model, U Model](cols ...modelscoped.Column[U]) SourceOperator[M]

func CastWhere 

func CastWhere[M Model, U Model, T comparable](col modelscoped.TypedColumn[U, T], valuer sqlbuilder.ColumnValuer[T]) SourceOperator[M]

func CrossJoinOn 

func CrossJoinOn[M Model, S Model, T comparable](
	on modelscoped.TypedColumn[M, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func CrossJoinOnAs 

func CrossJoinOnAs[M Model, B Model, S Model, T comparable](
	on modelscoped.TypedColumn[B, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func DefaultProject 

func DefaultProject[M Model](projects ...sqlfrag.Fragment) SourceOperator[M]

func DescSort 

func DescSort[M Model](col modelscoped.Column[M], ex ...sqlfrag.Fragment) SourceOperator[M]

func DistinctOn 

func DistinctOn[M Model](cols ...modelscoped.Column[M]) SourceOperator[M]

func DoDelete 

func DoDelete[M Model]() SourceOperator[M]

func DoDeleteHard 

func DoDeleteHard[M Model]() SourceOperator[M]

func DoUpdate 

func DoUpdate[M Model, T any](col modelscoped.TypedColumn[M, T], valuer sqlbuilder.ColumnValuer[T]) SourceOperator[M]

func DoUpdateSet 

func DoUpdateSet[M Model](m *M, columns ...modelscoped.Column[M]) SourceOperator[M]

func DoUpdateSetOmit 

func DoUpdateSetOmit[M Model](m *M, columns ...modelscoped.Column[M]) SourceOperator[M]

func DoUpdateSetOmitZero 

func DoUpdateSetOmitZero[M Model](m *M, exclude ...modelscoped.Column[M]) SourceOperator[M]

func ForKeyShare 

func ForKeyShare[M Model](optionFns ...func(LockOption)) SourceOperator[M]

func ForNoKeyUpdate 

func ForNoKeyUpdate[M Model](optionFns ...func(LockOption)) SourceOperator[M]

func ForShare 

func ForShare[M Model](optionFns ...func(LockOption)) SourceOperator[M]

func ForUpdate 

func ForUpdate[M Model](optionFns ...func(LockOption)) SourceOperator[M]

func FullJoinOn 

func FullJoinOn[M Model, S Model, T comparable](
	on modelscoped.TypedColumn[M, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func FullJoinOnAs 

func FullJoinOnAs[M Model, B Model, S Model, T comparable](
	on modelscoped.TypedColumn[B, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func InnerJoinOn 

func InnerJoinOn[M Model, S Model, T comparable](
	on modelscoped.TypedColumn[M, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func InnerJoinOnAs 

func InnerJoinOnAs[M Model, B Model, S Model, T comparable](
	on modelscoped.TypedColumn[B, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func JoinOn 

func JoinOn[M Model, S Model, T comparable](
	on modelscoped.TypedColumn[M, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func JoinOnAs 

func JoinOnAs[M Model, B Model, S Model, T comparable](
	on modelscoped.TypedColumn[B, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func LeftJoinOn 

func LeftJoinOn[M Model, S Model, T comparable](
	on modelscoped.TypedColumn[M, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func LeftJoinOnAs 

func LeftJoinOnAs[M Model, B Model, S Model, T comparable](
	on modelscoped.TypedColumn[B, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func Limit 

func Limit[M Model](limit int64, optFns ...LimitOptionFunc) SourceOperator[M]

func NewWhere 

func NewWhere[M Model, T comparable](op FilterOp, col modelscoped.TypedColumn[M, T], valuer sqlbuilder.ColumnValuer[T]) SourceOperator[M]

func OnConflictDoNothing 

func OnConflictDoNothing[M sqlbuilder.Model](cols modelscoped.ColumnSeq[M]) SourceOperator[M]

func OnConflictDoUpdateSet 

func OnConflictDoUpdateSet[M sqlbuilder.Model](cols modelscoped.ColumnSeq[M], toUpdates ...modelscoped.Column[M]) SourceOperator[M]

func OnConflictDoWith 

func OnConflictDoWith[M sqlbuilder.Model](
	cols modelscoped.ColumnSeq[M],
	with func(onConflictAddition sqlbuilder.OnConflictAddition) sqlbuilder.OnConflictAddition,
) SourceOperator[M]

func OrWhere 

func OrWhere[M Model, T comparable](col modelscoped.TypedColumn[M, T], valuer sqlbuilder.ColumnValuer[T]) SourceOperator[M]

func Project 

func Project[M Model](projects ...sqlfrag.Fragment) SourceOperator[M]

func Returning 

func Returning[M Model](cols ...modelscoped.Column[M]) SourceOperator[M]

func RightJoinOn 

func RightJoinOn[M Model, S Model, T comparable](
	on modelscoped.TypedColumn[M, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func RightJoinOnAs 

func RightJoinOnAs[M Model, B Model, S Model, T comparable](
	on modelscoped.TypedColumn[B, T],
	from modelscoped.TypedColumn[S, T],
	fromConditions ...SourceOperator[S],
) SourceOperator[M]

func Select 

func Select[M Model](cols ...modelscoped.Column[M]) SourceOperator[M]

func SourceOperatorFunc 

func SourceOperatorFunc[M Model](typ OperatorType, next func(in Source[M]) Source[M]) SourceOperator[M]

func Where 

func Where[M Model, T comparable](col modelscoped.TypedColumn[M, T], valuer sqlbuilder.ColumnValuer[T]) SourceOperator[M]

func WhereInSelectFrom 

func WhereInSelectFrom[M Model, S Model, T comparable](col modelscoped.TypedColumn[M, T], colSelect modelscoped.TypedColumn[S, T], source Source[S]) SourceOperator[M]

func WhereNotInSelectFrom 

func WhereNotInSelectFrom[M Model, S Model, T comparable](col modelscoped.TypedColumn[M, T], colSelect modelscoped.TypedColumn[S, T], source Source[S]) SourceOperator[M]

Source Files

View all Source files

Directories

Path Synopsis
ex
internal
Package filter GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE
 Package filter GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE
Package internal GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE
 Package internal GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE
flags
Package flags GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE
 Package flags GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.