diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql index 2dc1a9966b01a..2d7a57d4fba64 100644 --- a/coderd/database/dump.sql +++ b/coderd/database/dump.sql @@ -861,7 +861,7 @@ COMMENT ON COLUMN users.quiet_hours_schedule IS 'Daily (!) cron schedule (with o COMMENT ON COLUMN users.name IS 'Name of the Coder user'; -COMMENT ON COLUMN users.github_com_user_id IS 'The GitHub.com numerical user ID. At time of implementation, this is used to check if the user has starred the Coder repository.'; +COMMENT ON COLUMN users.github_com_user_id IS 'The GitHub.com numerical user ID. It is used to check if the user has starred the Coder repository. It is also used for filtering users in the users list CLI command, and may become more widely used in the future.'; COMMENT ON COLUMN users.hashed_one_time_passcode IS 'A hash of the one-time-passcode given to the user.'; diff --git a/coderd/database/migrations/000304_github_com_user_id_comment.down.sql b/coderd/database/migrations/000304_github_com_user_id_comment.down.sql new file mode 100644 index 0000000000000..104d9fbac79d3 --- /dev/null +++ b/coderd/database/migrations/000304_github_com_user_id_comment.down.sql @@ -0,0 +1 @@ +COMMENT ON COLUMN users.github_com_user_id IS 'The GitHub.com numerical user ID. At time of implementation, this is used to check if the user has starred the Coder repository.'; diff --git a/coderd/database/migrations/000304_github_com_user_id_comment.up.sql b/coderd/database/migrations/000304_github_com_user_id_comment.up.sql new file mode 100644 index 0000000000000..aa2c0cfa01d04 --- /dev/null +++ b/coderd/database/migrations/000304_github_com_user_id_comment.up.sql @@ -0,0 +1 @@ +COMMENT ON COLUMN users.github_com_user_id IS 'The GitHub.com numerical user ID. It is used to check if the user has starred the Coder repository. It is also used for filtering users in the users list CLI command, and may become more widely used in the future.'; diff --git a/coderd/database/models.go b/coderd/database/models.go index f4c3589010ba2..c5696f0dbf22c 100644 --- a/coderd/database/models.go +++ b/coderd/database/models.go @@ -3180,7 +3180,7 @@ type User struct { QuietHoursSchedule string `db:"quiet_hours_schedule" json:"quiet_hours_schedule"` // Name of the Coder user Name string `db:"name" json:"name"` - // The GitHub.com numerical user ID. At time of implementation, this is used to check if the user has starred the Coder repository. + // The GitHub.com numerical user ID. It is used to check if the user has starred the Coder repository. It is also used for filtering users in the users list CLI command, and may become more widely used in the future. GithubComUserID sql.NullInt64 `db:"github_com_user_id" json:"github_com_user_id"` // A hash of the one-time-passcode given to the user. HashedOneTimePasscode []byte `db:"hashed_one_time_passcode" json:"hashed_one_time_passcode"`