|
| 1 | +// |
| 2 | +// Copyright (C) 2024 IOTech Ltd |
| 3 | +// |
| 4 | +// SPDX-License-Identifier: Apache-2.0 |
| 5 | + |
| 6 | +package postgres |
| 7 | + |
| 8 | +import ( |
| 9 | + "context" |
| 10 | + "encoding/json" |
| 11 | + "fmt" |
| 12 | + "time" |
| 13 | + |
| 14 | + pgClient "github.com/edgexfoundry/edgex-go/internal/pkg/db/postgres" |
| 15 | + |
| 16 | + "github.com/edgexfoundry/go-mod-core-contracts/v3/errors" |
| 17 | + model "github.com/edgexfoundry/go-mod-core-contracts/v3/models" |
| 18 | + |
| 19 | + "github.com/jackc/pgx/v5" |
| 20 | + "github.com/jackc/pgx/v5/pgxpool" |
| 21 | + |
| 22 | + "github.com/google/uuid" |
| 23 | +) |
| 24 | + |
| 25 | +const ( |
| 26 | + eventTableName = "\"core-data\".event" |
| 27 | + |
| 28 | + // constants relate to the event struct field names |
| 29 | + deviceNameField = "DeviceName" |
| 30 | + originField = "Origin" |
| 31 | +) |
| 32 | + |
| 33 | +// AllEvents queries the events with the given range, offset, and limit |
| 34 | +func (c *Client) AllEvents(offset, limit int) ([]model.Event, errors.EdgeX) { |
| 35 | + ctx := context.Background() |
| 36 | + |
| 37 | + events, err := queryEvents(ctx, c.ConnPool, sqlQueryContentWithPagination(eventTableName), offset, limit) |
| 38 | + if err != nil { |
| 39 | + return nil, errors.NewCommonEdgeX(errors.KindDatabaseError, "failed to query all events", err) |
| 40 | + } |
| 41 | + |
| 42 | + return events, nil |
| 43 | +} |
| 44 | + |
| 45 | +// AddEvent adds a new event model to DB |
| 46 | +func (c *Client) AddEvent(e model.Event) (model.Event, errors.EdgeX) { |
| 47 | + ctx := context.Background() |
| 48 | + |
| 49 | + if e.Id == "" { |
| 50 | + e.Id = uuid.NewString() |
| 51 | + } |
| 52 | + event := model.Event{ |
| 53 | + Id: e.Id, |
| 54 | + DeviceName: e.DeviceName, |
| 55 | + ProfileName: e.ProfileName, |
| 56 | + SourceName: e.SourceName, |
| 57 | + Origin: e.Origin, |
| 58 | + Tags: e.Tags, |
| 59 | + } |
| 60 | + eventBytes, err := json.Marshal(event) |
| 61 | + if err != nil { |
| 62 | + return model.Event{}, errors.NewCommonEdgeX(errors.KindContractInvalid, "unable to JSON marshal event model", err) |
| 63 | + } |
| 64 | + |
| 65 | + _, err = c.ConnPool.Exec( |
| 66 | + ctx, |
| 67 | + sqlInsert(eventTableName, idCol, contentCol), |
| 68 | + e.Id, |
| 69 | + eventBytes, |
| 70 | + ) |
| 71 | + if err != nil { |
| 72 | + //if pgClient.IsDupIdError(err) { |
| 73 | + // return model.Event{}, errors.NewCommonEdgeX(errors.KindDuplicateName, fmt.Sprintf("event id '%s' already exists", e.Id), err) |
| 74 | + //} |
| 75 | + return model.Event{}, pgClient.WrapDBError("failed to insert event", err) |
| 76 | + } |
| 77 | + |
| 78 | + // TODO: readings included in this event will be added to database in the following PRs |
| 79 | + |
| 80 | + return event, nil |
| 81 | +} |
| 82 | + |
| 83 | +// EventById gets an event by id |
| 84 | +func (c *Client) EventById(id string) (model.Event, errors.EdgeX) { |
| 85 | + ctx := context.Background() |
| 86 | + var event model.Event |
| 87 | + |
| 88 | + row := c.ConnPool.QueryRow(ctx, sqlQueryContentById(eventTableName), id) |
| 89 | + err := row.Scan(&event) |
| 90 | + if err != nil { |
| 91 | + return event, pgClient.WrapDBError(fmt.Sprintf("failed to query event with id '%s'", id), err) |
| 92 | + } |
| 93 | + |
| 94 | + return event, nil |
| 95 | +} |
| 96 | + |
| 97 | +// EventTotalCount returns the total count of Event from db |
| 98 | +func (c *Client) EventTotalCount() (uint32, errors.EdgeX) { |
| 99 | + return getTotalRowsCount(context.Background(), c.ConnPool, sqlQueryCount(eventTableName)) |
| 100 | +} |
| 101 | + |
| 102 | +// EventCountByDeviceName returns the count of Event associated a specific Device from db |
| 103 | +func (c *Client) EventCountByDeviceName(deviceName string) (uint32, errors.EdgeX) { |
| 104 | + fieldMap := map[string]any{deviceNameField: deviceName} |
| 105 | + sqlStatement, err := sqlQueryCountByJSONField(eventTableName, fieldMap) |
| 106 | + if err != nil { |
| 107 | + return 0, errors.NewCommonEdgeXWrapper(err) |
| 108 | + } |
| 109 | + |
| 110 | + return getTotalRowsCount(context.Background(), c.ConnPool, sqlStatement) |
| 111 | +} |
| 112 | + |
| 113 | +// EventCountByTimeRange returns the count of Event by time range from db |
| 114 | +func (c *Client) EventCountByTimeRange(start int, end int) (uint32, errors.EdgeX) { |
| 115 | + return getTotalRowsCount(context.Background(), c.ConnPool, sqlQueryCountByJSONFieldTimeRange(eventTableName, originField), start, end) |
| 116 | +} |
| 117 | + |
| 118 | +// EventsByDeviceName query events by offset, limit and device name |
| 119 | +func (c *Client) EventsByDeviceName(offset int, limit int, name string) ([]model.Event, errors.EdgeX) { |
| 120 | + fieldMap := map[string]any{deviceNameField: name} |
| 121 | + sqlStatement, err := sqlQueryContentByJSONField(eventTableName, fieldMap) |
| 122 | + if err != nil { |
| 123 | + return nil, errors.NewCommonEdgeXWrapper(err) |
| 124 | + } |
| 125 | + |
| 126 | + events, err := queryEvents(context.Background(), c.ConnPool, sqlStatement, offset, limit) |
| 127 | + if err != nil { |
| 128 | + return nil, errors.NewCommonEdgeX(errors.KindDatabaseError, fmt.Sprintf("failed to query events by device '%s'", name), err) |
| 129 | + } |
| 130 | + return events, nil |
| 131 | +} |
| 132 | + |
| 133 | +// EventsByTimeRange query events by time range, offset, and limit |
| 134 | +func (c *Client) EventsByTimeRange(start int, end int, offset int, limit int) ([]model.Event, errors.EdgeX) { |
| 135 | + ctx := context.Background() |
| 136 | + sqlStatement := sqlQueryContentByJSONFieldTimeRange(eventTableName, originField) |
| 137 | + |
| 138 | + events, err := queryEvents(ctx, c.ConnPool, sqlStatement, start, end, offset, limit) |
| 139 | + if err != nil { |
| 140 | + return nil, errors.NewCommonEdgeXWrapper(err) |
| 141 | + } |
| 142 | + return events, nil |
| 143 | +} |
| 144 | + |
| 145 | +// DeleteEventById removes an event by id |
| 146 | +func (c *Client) DeleteEventById(id string) errors.EdgeX { |
| 147 | + sqlStatement := sqlDeleteById(eventTableName) |
| 148 | + |
| 149 | + err := deleteEvents(context.Background(), c.ConnPool, sqlStatement, id) |
| 150 | + if err != nil { |
| 151 | + return errors.NewCommonEdgeX(errors.Kind(err), fmt.Sprintf("failed delete event with id '%s'", id), err) |
| 152 | + } |
| 153 | + |
| 154 | + // TODO: delete related readings associated to the deleted events |
| 155 | + |
| 156 | + return nil |
| 157 | +} |
| 158 | + |
| 159 | +// DeleteEventsByDeviceName deletes specific device's events and corresponding readings |
| 160 | +// This function is implemented to starts up two goroutines to delete readings and events in the background to achieve better performance |
| 161 | +func (c *Client) DeleteEventsByDeviceName(deviceName string) errors.EdgeX { |
| 162 | + ctx := context.Background() |
| 163 | + fieldMap := map[string]any{deviceNameField: deviceName} |
| 164 | + |
| 165 | + sqlStatement, edgexErr := sqlDeleteByJSONField(eventTableName, fieldMap) |
| 166 | + if edgexErr != nil { |
| 167 | + return errors.NewCommonEdgeXWrapper(edgexErr) |
| 168 | + } |
| 169 | + |
| 170 | + go func() { |
| 171 | + err := deleteEvents(ctx, c.ConnPool, sqlStatement) |
| 172 | + if err != nil { |
| 173 | + c.loggingClient.Errorf("failed delete event with device '%s': %v", deviceName, err) |
| 174 | + } |
| 175 | + }() |
| 176 | + |
| 177 | + // TODO: delete related readings associated to the deleted events |
| 178 | + |
| 179 | + return nil |
| 180 | +} |
| 181 | + |
| 182 | +// DeleteEventsByAge deletes events and their corresponding readings that are older than age |
| 183 | +// This function is implemented to starts up two goroutines to delete readings and events in the background to achieve better performance |
| 184 | +func (c *Client) DeleteEventsByAge(age int64) errors.EdgeX { |
| 185 | + ctx := context.Background() |
| 186 | + expireTimestamp := time.Now().UnixNano() - age |
| 187 | + sqlStatement := sqlDeleteByAgeInJSONField(eventTableName, originField) |
| 188 | + |
| 189 | + go func() { |
| 190 | + err := deleteEvents(ctx, c.ConnPool, sqlStatement, expireTimestamp) |
| 191 | + if err != nil { |
| 192 | + c.loggingClient.Errorf("failed delete event by age '%d' nanoseconds: %v", age, err) |
| 193 | + } |
| 194 | + }() |
| 195 | + |
| 196 | + // TODO: delete related readings associated to the deleted events |
| 197 | + |
| 198 | + return nil |
| 199 | +} |
| 200 | + |
| 201 | +// queryEvents queries the data rows with given sql statement and passed args, and unmarshal the data rows to the Event model slice |
| 202 | +func queryEvents(ctx context.Context, connPool *pgxpool.Pool, sql string, args ...any) ([]model.Event, errors.EdgeX) { |
| 203 | + rows, err := connPool.Query(ctx, sql, args...) |
| 204 | + if err != nil { |
| 205 | + return nil, pgClient.WrapDBError("query failed", err) |
| 206 | + } |
| 207 | + |
| 208 | + defer rows.Close() |
| 209 | + |
| 210 | + var events []model.Event |
| 211 | + events, err = pgx.CollectRows(rows, func(row pgx.CollectableRow) (model.Event, error) { |
| 212 | + var event model.Event |
| 213 | + err := rows.Scan(&event) |
| 214 | + |
| 215 | + // TODO: readings data will be added to the event model in the following PRs |
| 216 | + |
| 217 | + return event, err |
| 218 | + }) |
| 219 | + |
| 220 | + if err != nil { |
| 221 | + return nil, pgClient.WrapDBError("failed to scan events", err) |
| 222 | + } |
| 223 | + |
| 224 | + return events, nil |
| 225 | +} |
| 226 | + |
| 227 | +// deleteEvents delete the data rows with given sql statement and passed args |
| 228 | +func deleteEvents(ctx context.Context, connPool *pgxpool.Pool, sqlStatement string, args ...any) errors.EdgeX { |
| 229 | + commandTag, err := connPool.Exec( |
| 230 | + ctx, |
| 231 | + sqlStatement, |
| 232 | + args..., |
| 233 | + ) |
| 234 | + if commandTag.RowsAffected() == 0 { |
| 235 | + return errors.NewCommonEdgeX(errors.KindContractInvalid, "no event found", nil) |
| 236 | + } |
| 237 | + if err != nil { |
| 238 | + return pgClient.WrapDBError("event(s) delete failed", err) |
| 239 | + } |
| 240 | + return nil |
| 241 | +} |
0 commit comments