drone/types/space.go
Marko Gaćeša a79e187a88 DB & API refactor: Use snake case (#144)
Update DB and API to follow Harness Standard
2022-12-29 13:53:08 -08:00

44 lines
1.7 KiB
Go

// Copyright 2022 Harness Inc. All rights reserved.
// Use of this source code is governed by the Polyform Free Trial License
// that can be found in the LICENSE.md file for this repository.
package types
import (
"github.com/harness/gitness/types/enum"
)
/*
Space represents a space.
There isn't a one-solves-all hierarchical data structure for DBs,
so for now we are using a mix of materialized paths and adjacency list.
Every space stores its parent, and a space's path is stored in a separate table.
PRO: Quick lookup of childs, quick lookup based on fqdn (apis)
CON: Changing a space uid requires changing all its ancestors' Paths.
Interesting reads:
https://stackoverflow.com/questions/4048151/what-are-the-options-for-storing-hierarchical-data-in-a-relational-database
https://www.slideshare.net/billkarwin/models-for-hierarchical-data
*/
type Space struct {
// TODO: int64 ID doesn't match DB
ID int64 `db:"space_id" json:"id"`
ParentID int64 `db:"space_parent_id" json:"parent_id"`
Path string `db:"space_path" json:"path"`
UID string `db:"space_uid" json:"uid"`
Description string `db:"space_description" json:"description"`
IsPublic bool `db:"space_is_public" json:"is_public"`
CreatedBy int64 `db:"space_created_by" json:"created_by"`
Created int64 `db:"space_created" json:"created"`
Updated int64 `db:"space_updated" json:"updated"`
}
// Stores spaces query parameters.
type SpaceFilter struct {
Page int `json:"page"`
Size int `json:"size"`
Query string `json:"query"`
Sort enum.SpaceAttr `json:"sort"`
Order enum.Order `json:"order"`
}