JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

satellite/satellitedb/dbx: add docs for user.dbx

Browse Source 
Change-Id: I346ceaedf6963169bb9d6d1435454016239d4cb1
This commit is contained in:
Egon Elbre 2023-02-08 14:56:50 +02:00
parent a1bd36bb64
commit dd3d051170
1 changed files with 52 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
satellite/satellitedb/dbx/user.dbx
View File

@ -1,44 +1,79 @@
//--- satellite console ---//
// User contains information about people who have frontend access.
model user (
key id
// id is an uuid for the user.
field id blob
// email is the user specified email.
field email text ( updatable )
// normalized_email is the email transformed by usual rules, e.g. case-insensitive.
// See satellitedb.normalizeEmail for the specific details.
field normalized_email text ( updatable )
// full_name is the user specified name.
field full_name text ( updatable )
// short_name is the user specified name, that should be usually used for informal information.
field short_name text ( updatable, nullable )
// password_hash is the bcrypt hash.
field password_hash blob ( updatable )
// status indicates whether the user is inactive=0, active=1, or deleted=2. See console.UserStatus for details.
field status int ( updatable, autoinsert )
// partner_id is an UUID that refers to rewards.PartnersStaticDB.
// deprecated: use user_agent instead.
// note: this field is duplicated in value_attribution.project_id.
field partner_id blob ( nullable )
// user_agent contains the partner parameter from registration.
field user_agent blob ( nullable )
// created_at indicates when the user was created.
field created_at timestamp ( autoinsert )
// project_limit limits how many projects a user can create.
field project_limit int ( updatable, default 0 )
// project_bandwidth_limit is project default maximum allowed bandwidth per month in bytes.
field project_bandwidth_limit int64 ( updatable, default 0 )
// project_storage_limit is project default maximum allowed bytes that can be stored.
field project_storage_limit int64 ( updatable, default 0 )
// segment_limit is project default on how many segments can be stored in the project.
field project_segment_limit int64 ( updatable, default 0 )
// paid_tier indicates whether user is paying for access.
field paid_tier bool ( updatable, default false )
// position is user-specified position in a company.
field position text ( updatable, nullable )
// company_name is user-specified company name.
field company_name text ( updatable, nullable )
// company_size is user-specified company size estimate.
field company_size int ( updatable, nullable )
// working_on is user-specified info on what the user intends to use things for.
field working_on text ( updatable, nullable )
// is_professional indicates whether the user intends to use it for personal or business.
field is_professional bool ( updatable, default false )
// empolyee_count is user-specified estimate on the employee count in the company.
field employee_count text ( updatable, nullable )
// have_sales_contact indicates whether the user should be contacted by sales.
field have_sales_contact bool ( updatable, default false )
// mfa_enabled indicates whether multi-factor authentication is enabled for this user.
field mfa_enabled bool ( updatable, default false )
// mfa_secret_key is the shared key between authenticator and the frontend.
field mfa_secret_key text ( updatable, nullable )
// mfa_recovery_codes is used for disabling multi-factor authentication.
field mfa_recovery_codes text ( updatable, nullable )
// signup_promo_code is the promo code, if it was used when signing up.
field signup_promo_code text ( updatable, nullable )
// verification_reminders counts how many times a verification reminder email has been sent.
field verification_reminders int ( updatable, default 0 )
// failed_login_count keeps track on how many times login has failed.
field failed_login_count int ( updatable, nullable )
// login_lockout_expiration is used when the user has failed to login too many times.
field login_lockout_expiration timestamp ( updatable, nullable )
// signup_captcha is the captcha score recorded during sign-up.
field signup_captcha float64 ( nullable )
)
@ -99,15 +134,17 @@ read one (
where webapp_session.id = ?
)
//--- satellite registration token for Vanguard release (temporary table) ---//
// registration_token is used to limit user registration to the satellite.
model registration_token (
key secret
unique owner_id
// secret is random identifier used during registration.
field secret blob
// owner_id is the user who claimed this token. This refers to user.id column.
field owner_id blob ( updatable, nullable )
// project_limit is the default limit on how many projects the user can create.
field project_limit int
field created_at timestamp ( autoinsert )
@ -124,13 +161,14 @@ read one (
)
update registration_token ( where registration_token.secret = ? )
//--- satellite reset password token ---//
// reset_password_token is a token that is used when resetting password.
model reset_password_token (
key secret
unique owner_id
// secret is sent to the users email, to verify their account.
field secret blob
// owner_id is the associated user. This refers to user.id column.
field owner_id blob ( updatable )
field created_at timestamp ( autoinsert )
@ -147,13 +185,18 @@ read one (
)
delete reset_password_token ( where reset_password_token.secret = ? )
//-- Account Freeze Events --//
// account_freeze_event contains information about the user account getting
// frozen due to suspicious or bad activity.
model account_freeze_event (
key user_id event
// user_id refers to user.id column.
field user_id blob
field event int // enum indicating the type of event
// event indicates the console.AccountFreezeEventType. Freeze=0, Warning=1.
field event int
// limits are the limits before the freeze begun.
field limits json ( nullable, updatable )
// created_at indicates when the freeze was created.
field created_at timestamp ( default current_timestamp )
)
@ -172,11 +215,13 @@ update account_freeze_event (
delete account_freeze_event ( where account_freeze_event.user_id = ? )
//-- User Settings --//
// user_settings table is used to persist user preferences.
model user_settings (
key user_id
// user_id refers to user.id column.
field user_id blob
// session_minutes indicates the time when the user should be logged out.
field session_minutes uint ( nullable, updatable )
)