models

Documentation

Index

• func CreateTenantTable(dropExistingTable bool)
• func CreateUserTable(dropExistingTable bool)
• func InitDB(dbHost, dbPort, dbUser, dbPassword, dbName string) *sqlx.DB
• type Tenant
  • func CreateTenant(schema string, name string) (*Tenant, error)
  • func FetchTenants(page uint64, pageSize uint64) ([]Tenant, uint64)
  • func FindTenantById(id uint64) (*Tenant, error)
  • func FindTenantBySchema(schema string) (*Tenant, error)
• type User
  • func CreateUser(email string, firstName string, lastName string, password string, ...) (*User, error)
  • func FindUserByEmail(email string) (*User, error)

Functions

func CreateTenantTable

func CreateTenantTable(dropExistingTable bool)

*

• Function will create the `tenants` table in the database.

func CreateUserTable

func CreateUserTable(dropExistingTable bool)

*

• Function will create the `users` table in the database.

func InitDB

func InitDB(dbHost, dbPort, dbUser, dbPassword, dbName string) *sqlx.DB

*

• Function initializes our connection with the `postgres` database for this
• web-application and saves the db connection instance in a global variable.

Types

type Tenant

type Tenant struct {
	Id     uint64         `db:"id"`
	Schema sql.NullString `db:"schema"`
	Name   sql.NullString `db:"name"`
}

func CreateTenant

func CreateTenant(schema string, name string) (*Tenant, error)

*

• Function will create a tenant, if validation passess, and reutrns the `tenant`
• struct else returns the error.

func FetchTenants

func FetchTenants(page uint64, pageSize uint64) ([]Tenant, uint64)

*

• Function will return paginated list of tenants.

func FindTenantById

func FindTenantById(id uint64) (*Tenant, error)

*

• Function will return the `tenant` struct if it exists in the database or
• return an error.

func FindTenantBySchema

func FindTenantBySchema(schema string) (*Tenant, error)

*

• Function will return the `tenant` struct if it exists in the database or
• return an error.

type User

type User struct {
	TenantId     int64          `db:"tenant_id"`
	TenantSchema sql.NullString `db:"tenant_schema"`
	Id           int64          `db:"id"`
	FirstName    sql.NullString `db:"first_name"`
	LastName     sql.NullString `db:"last_name"`
	PasswordHash sql.NullString `db:"password_hash"`
	Email        sql.NullString `db:"email"`
	GroupId      uint8          `db:"group_id"`
}

func CreateUser

func CreateUser(email string, firstName string, lastName string, password string, tenantId int64, tenantSchema string, groupId int64) (*User, error)

*

• Function will create a user, if validation passess, and reutrns the `user`
• struct else returns the error.

func FindUserByEmail

func FindUserByEmail(email string) (*User, error)

*

• Function will return the `user` struct if it exists in the database or
• return an error.