Skip to content

Commit

Permalink
Elide the expiration column and checking when expiration is either di…
Browse files Browse the repository at this point in the history
…sabled or the relationship cannot be marked as expiring
  • Loading branch information
josephschorr committed Dec 16, 2024
1 parent 0f37897 commit 81ecf98
Show file tree
Hide file tree
Showing 25 changed files with 632 additions and 429 deletions.
3 changes: 3 additions & 0 deletions internal/datastore/common/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ type SchemaInformation struct {

// WithIntegrityColumns is a flag to indicate if the schema has integrity columns.
WithIntegrityColumns bool `debugmap:"visible"`

// ExpirationDisabled is a flag to indicate whether expiration support is disabled.
ExpirationDisabled bool `debugmap:"visible"`
}

func (si SchemaInformation) debugValidate() {
Expand Down
9 changes: 9 additions & 0 deletions internal/datastore/common/schema_options.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 28 additions & 20 deletions internal/datastore/common/sql.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,7 @@ func NewSchemaQueryFiltererForRelationshipsSelect(schema SchemaInformation, filt
log.Warn().Msg("SchemaQueryFilterer: filterMaximumIDCount not set, defaulting to 100")
}

// Filter out any expired relationships.
// TODO(jschorr): Make this depend on whether expiration is necessary.
queryBuilder := sq.StatementBuilder.PlaceholderFormat(schema.PlaceholderFormat).Select().Where(sq.Or{
sq.Eq{schema.ColExpiration: nil},
sq.Expr(schema.ColExpiration + " > " + schema.NowFunction + "()"),
})

queryBuilder := sq.StatementBuilder.PlaceholderFormat(schema.PlaceholderFormat).Select()
return SchemaQueryFilterer{
schema: schema,
queryBuilder: queryBuilder,
Expand All @@ -134,13 +128,6 @@ func NewSchemaQueryFiltererWithStartingQuery(schema SchemaInformation, startingQ
log.Warn().Msg("SchemaQueryFilterer: filterMaximumIDCount not set, defaulting to 100")
}

// Filter out any expired relationships.
// TODO(jschorr): Make this depend on whether expiration is necessary.
startingQuery = startingQuery.Where(sq.Or{
sq.Eq{schema.ColExpiration: nil},
sq.Expr(schema.ColExpiration + " > " + schema.NowFunction + "()"),
})

return SchemaQueryFilterer{
schema: schema,
queryBuilder: startingQuery,
Expand Down Expand Up @@ -179,7 +166,21 @@ func (sqf SchemaQueryFilterer) UnderlyingQueryBuilder() sq.SelectBuilder {
spiceerrors.DebugAssert(func() bool {
return sqf.isCustomQuery
}, "UnderlyingQueryBuilder should only be called on custom queries")
return sqf.queryBuilder
return sqf.queryBuilderWithExpirationFilter(false)
}

// queryBuilderWithExpirationFilter returns the query builder with the expiration filter applied, when necessary.
// Note that this adds the clause to the existing builder.
func (sqf SchemaQueryFilterer) queryBuilderWithExpirationFilter(skipExpiration bool) sq.SelectBuilder {
if sqf.schema.ExpirationDisabled || skipExpiration {
return sqf.queryBuilder
}

// Filter out any expired relationships.
return sqf.queryBuilder.Where(sq.Or{
sq.Eq{sqf.schema.ColExpiration: nil},
sq.Expr(sqf.schema.ColExpiration + " > " + sqf.schema.NowFunction + "()"),
})
}

func (sqf SchemaQueryFilterer) TupleOrder(order options.SortOrder) SchemaQueryFilterer {
Expand Down Expand Up @@ -470,6 +471,7 @@ func (sqf SchemaQueryFilterer) FilterWithRelationshipsFilter(filter datastore.Re

if filter.OptionalExpirationOption == datastore.ExpirationFilterOptionHasExpiration {
csqf.queryBuilder = csqf.queryBuilder.Where(sq.NotEq{csqf.schema.ColExpiration: nil})
spiceerrors.DebugAssert(func() bool { return !sqf.schema.ExpirationDisabled }, "expiration filter requested but schema does not support expiration")
} else if filter.OptionalExpirationOption == datastore.ExpirationFilterOptionNoExpiration {
csqf.queryBuilder = csqf.queryBuilder.Where(sq.Eq{csqf.schema.ColExpiration: nil})
}
Expand Down Expand Up @@ -666,6 +668,7 @@ func (exc QueryRelationshipsExecutor) ExecuteQuery(
builder := RelationshipsQueryBuilder{
Schema: query.schema,
SkipCaveats: queryOpts.SkipCaveats,
SkipExpiration: queryOpts.SkipExpiration,
filteringValues: query.filteringColumnTracker,
baseQueryBuilder: query,
}
Expand All @@ -676,8 +679,9 @@ func (exc QueryRelationshipsExecutor) ExecuteQuery(
// RelationshipsQueryBuilder is a builder for producing the SQL and arguments necessary for reading
// relationships.
type RelationshipsQueryBuilder struct {
Schema SchemaInformation
SkipCaveats bool
Schema SchemaInformation
SkipCaveats bool
SkipExpiration bool

filteringValues map[string]ColumnTracker
baseQueryBuilder SchemaQueryFilterer
Expand All @@ -703,7 +707,9 @@ func (b RelationshipsQueryBuilder) SelectSQL() (string, []any, error) {
columnNamesToSelect = append(columnNamesToSelect, b.Schema.ColCaveatName, b.Schema.ColCaveatContext)
}

columnNamesToSelect = append(columnNamesToSelect, b.Schema.ColExpiration)
if !b.SkipExpiration && !b.Schema.ExpirationDisabled {
columnNamesToSelect = append(columnNamesToSelect, b.Schema.ColExpiration)
}

if b.Schema.WithIntegrityColumns {
columnNamesToSelect = append(columnNamesToSelect, b.Schema.ColIntegrityKeyID, b.Schema.ColIntegrityHash, b.Schema.ColIntegrityTimestamp)
Expand All @@ -713,7 +719,7 @@ func (b RelationshipsQueryBuilder) SelectSQL() (string, []any, error) {
columnNamesToSelect = append(columnNamesToSelect, "1")
}

sqlBuilder := b.baseQueryBuilder.queryBuilder
sqlBuilder := b.baseQueryBuilder.queryBuilderWithExpirationFilter(b.SkipExpiration)
sqlBuilder = sqlBuilder.Columns(columnNamesToSelect...)

return sqlBuilder.ToSql()
Expand Down Expand Up @@ -788,7 +794,9 @@ func ColumnsToSelect[CN any, CC any, EC any](
colsToSelect = append(colsToSelect, caveatName, caveatCtx)
}

colsToSelect = append(colsToSelect, expiration)
if !b.SkipExpiration && !b.Schema.ExpirationDisabled {
colsToSelect = append(colsToSelect, expiration)
}

if b.Schema.WithIntegrityColumns {
colsToSelect = append(colsToSelect, integrityKeyID, integrityHash, timestamp)
Expand Down
Loading

0 comments on commit 81ecf98

Please sign in to comment.