package storage import ( "database/sql" "github.com/matrix-org/dendrite/roomserver/types" ) const eventTypesSchema = ` -- Numeric versions of the event "type"s. Event types tend to be taken from a -- small common pool. Assigning each a numeric ID should reduce the amount of -- data that needs to be stored and fetched from the database. -- It also means that many operations can work with int64 arrays rather than -- string arrays which may help reduce GC pressure. -- Well known event types are pre-assigned numeric IDs: -- 1 -> m.room.create -- 2 -> m.room.power_levels -- 3 -> m.room.join_rules -- 4 -> m.room.third_party_invite -- 5 -> m.room.member -- 6 -> m.room.redaction -- 7 -> m.room.history_visibility -- Picking well-known numeric IDs for the events types that require special -- attention during state conflict resolution means that we write that code -- using numeric constants. -- It also means that the numeric IDs for common event types should be -- consistent between different instances which might make ad-hoc debugging -- easier. -- Other event types are automatically assigned numeric IDs starting from 2**16. -- This leaves room to add more pre-assigned numeric IDs and clearly separates -- the automatically assigned IDs from the pre-assigned IDs. CREATE SEQUENCE IF NOT EXISTS event_type_nid_seq START 65536; CREATE TABLE IF NOT EXISTS event_types ( -- Local numeric ID for the event type. event_type_nid BIGINT PRIMARY KEY DEFAULT nextval('event_type_nid_seq'), -- The string event_type. event_type TEXT NOT NULL CONSTRAINT event_type_unique UNIQUE ); INSERT INTO event_types (event_type_nid, event_type) VALUES (1, 'm.room.create'), (2, 'm.room.power_levels'), (3, 'm.room.join_rules'), (4, 'm.room.third_party_invite'), (5, 'm.room.member'), (6, 'm.room.redaction'), (7, 'm.room.history_visibility') ON CONFLICT DO NOTHING; ` // Assign a new numeric event type ID. // The usual case is that the event type is not in the database. // In that case the ID will be assigned using the next value from the sequence. // We use `RETURNING` to tell postgres to return the assigned ID. // But it's possible that the type was added in a query that raced with us. // This will result in a conflict on the event_type_unique constraint, in this // case we do nothing. Postgresql won't return a row in that case so we rely on // the caller catching the sql.ErrNoRows error and running a select to get the row. // We could get postgresql to return the row on a conflict by updating the row // but it doesn't seem like a good idea to modify the rows just to make postgresql // return it. Modifying the rows will cause postgres to assign a new tuple for the // row even though the data doesn't change resulting in unncesssary modifications // to the indexes. const insertEventTypeNIDSQL = "" + "INSERT INTO event_types (event_type) VALUES ($1)" + " ON CONFLICT ON CONSTRAINT event_type_unique" + " DO NOTHING RETURNING (event_type_nid)" const selectEventTypeNIDSQL = "" + "SELECT event_type_nid FROM event_types WHERE event_type = $1" type eventTypeStatements struct { insertEventTypeNIDStmt *sql.Stmt selectEventTypeNIDStmt *sql.Stmt } func (s *eventTypeStatements) prepare(db *sql.DB) (err error) { _, err = db.Exec(eventTypesSchema) if err != nil { return } if s.insertEventTypeNIDStmt, err = db.Prepare(insertEventTypeNIDSQL); err != nil { return } if s.selectEventTypeNIDStmt, err = db.Prepare(selectEventTypeNIDSQL); err != nil { return } return } func (s *eventTypeStatements) insertEventTypeNID(eventType string) (types.EventTypeNID, error) { var eventTypeNID int64 err := s.insertEventTypeNIDStmt.QueryRow(eventType).Scan(&eventTypeNID) return types.EventTypeNID(eventTypeNID), err } func (s *eventTypeStatements) selectEventTypeNID(eventType string) (types.EventTypeNID, error) { var eventTypeNID int64 err := s.selectEventTypeNIDStmt.QueryRow(eventType).Scan(&eventTypeNID) return types.EventTypeNID(eventTypeNID), err }