Skip to main content

savedview.go

savedview.go - Overview​

  1. Overview

Defines the SavedView struct, which represents a saved view configuration in the system, and its associated properties for database storage and JSON serialization.

  1. Detailed Documentation

type SavedView struct​

Purpose: Represents a saved view, storing its configuration and metadata. It includes fields for identification, auditing, organization, and the view's data.

Fields:​

  • bun.BaseModel bun:"table:saved_views":
    • Purpose: Provides base model functionality for Bun ORM, indicating the database table name.
  • Identifiable:
    • Purpose: Embedded struct providing ID field.
  • TimeAuditable:
    • Purpose: Embedded struct providing CreatedAt and UpdatedAt fields.
  • UserAuditable:
    • Purpose: Embedded struct providing CreatedBy and UpdatedBy fields.
  • OrgID string json:"orgId" bun:"org_id,notnull":
    • Purpose: The ID of the organization to which the saved view belongs.
    • Type: string
    • Description: Organization ID.
  • Name string json:"name" bun:"name,type:text,notnull":
    • Purpose: The name of the saved view.
    • Type: string
    • Description: Saved view name.
  • Category string json:"category" bun:"category,type:text,notnull":
    • Purpose: The category of the saved view.
    • Type: string
    • Description: Saved view category.
  • SourcePage string json:"sourcePage" bun:"source_page,type:text,notnull":
    • Purpose: The source page where the saved view is used.
    • Type: string
    • Description: Source page of the saved view.
  • Tags string json:"tags" bun:"tags,type:text":
    • Purpose: Tags associated with the saved view.
    • Type: string
    • Description: Saved view tags.
  • Data string json:"data" bun:"data,type:text,notnull":
    • Purpose: The core data of the saved view, likely a JSON or serialized representation.
    • Type: string
    • Description: Saved view data.
  • ExtraData string json:"extraData" bun:"extra_data,type:text":
    • Purpose: Additional data associated with the saved view.
    • Type: string
    • Description: Extra data for the saved view.
  1. Code Examples

None

  1. Clarity and Accuracy

The documentation is based on the code provided.

  1. Markdown & MDX Perfection

The markdown is formatted correctly.

  1. Edge Cases To Avoid Breaking MDX

No edge cases were identified.

  1. Getting Started Relevance

Include in Getting Started: NO