ensure history table is created with Postgraphile 'omit' annotation i…

…f needed
streamingfast · Nov 6, 2023 · 28197f7 · 28197f7
1 parent 3558854
commit 28197f7
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/db/db.go b/db/db.go
@@ -287,7 +287,7 @@ func (l *Loader) Setup(ctx context.Context, schemaBytes []byte, withPostgraphile
 		return fmt.Errorf("setup cursor table: %w", err)
 	}
 
-	if err := l.setupHistoryTable(ctx); err != nil {
+	if err := l.setupHistoryTable(ctx, withPostgraphile); err != nil {
 		return fmt.Errorf("setup history table: %w", err)
 	}
 
@@ -300,11 +300,11 @@ func (l *Loader) setupCursorTable(ctx context.Context, withPostgraphile bool) er
 	return err
 }
 
-func (l *Loader) setupHistoryTable(ctx context.Context) error {
+func (l *Loader) setupHistoryTable(ctx context.Context, withPostgraphile bool) error {
 	if l.getDialect().OnlyInserts() {
 		return nil
 	}
-	query := l.getDialect().GetCreateHistoryQuery(l.schema)
+	query := l.getDialect().GetCreateHistoryQuery(l.schema, withPostgraphile)
 	_, err := l.ExecContext(ctx, query)
 	return err
 }

diff --git a/db/dialect.go b/db/dialect.go
@@ -18,7 +18,7 @@ func (e UnknownDriverError) Error() string {
 
 type dialect interface {
 	GetCreateCursorQuery(schema string, withPostgraphile bool) string
-	GetCreateHistoryQuery(schema string) string
+	GetCreateHistoryQuery(schema string, withPostgraphile bool) string
 	ExecuteSetupScript(ctx context.Context, l *Loader, schemaSql string) error
 	DriverSupportRowsAffected() bool
 	GetUpdateCursorQuery(table, moduleHash string, cursor *sink.Cursor, block_num uint64, block_id string) string

diff --git a/db/dialect_clickhouse.go b/db/dialect_clickhouse.go
@@ -97,7 +97,7 @@ func (d clickhouseDialect) GetCreateCursorQuery(schema string, withPostgraphile
 	`), EscapeIdentifier(schema), EscapeIdentifier(CURSORS_TABLE))
 }
 
-func (d clickhouseDialect) GetCreateHistoryQuery(schema string) string {
+func (d clickhouseDialect) GetCreateHistoryQuery(schema string, withPostgraphile bool) string {
 	panic("clickhouse does not support reorg management")
 }
 

diff --git a/db/dialect_postgres.go b/db/dialect_postgres.go
@@ -189,7 +189,7 @@ func (d postgresDialect) GetCreateCursorQuery(schema string, withPostgraphile bo
 	return out
 }
 
-func (d postgresDialect) GetCreateHistoryQuery(schema string) string {
+func (d postgresDialect) GetCreateHistoryQuery(schema string, withPostgraphile bool) string {
 	out := fmt.Sprintf(cli.Dedent(`
 		create table if not exists %s
 		(
@@ -203,6 +203,10 @@ func (d postgresDialect) GetCreateHistoryQuery(schema string) string {
 		`),
 		d.historyTable(schema),
 	)
+	if withPostgraphile {
+		out += fmt.Sprintf("COMMENT ON TABLE %s.%s IS E'@omit';",
+			EscapeIdentifier(schema), EscapeIdentifier(HISTORY_TABLE))
+	}
 	return out
 }