db

Documentation

Overview

------------------------------------------------------------------------ SPDX-FileCopyrightText: Copyright © 2024 bomctl authors SPDX-FileName: internal/pkg/db/db.go SPDX-FileType: SOURCE SPDX-License-Identifier: Apache-2.0 ------------------------------------------------------------------------ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ------------------------------------------------------------------------

Index

• func AddDocument(document PBToORMConverter) error
• func CreateSchema(dbFile string) (*gorm.DB, error)
• func GetDocumentByID(id uint32) *protobom.Document
• type ORMToPBConverter
• type PBToORMConverter

Functions

func AddDocument

func AddDocument(document PBToORMConverter) error

Insert protobom Document into `documents` table.

func CreateSchema

func CreateSchema(dbFile string) (*gorm.DB, error)

Create database and initialize schema.

func GetDocumentByID

func GetDocumentByID(id uint32) *protobom.Document

Types

type ORMToPBConverter

type ORMToPBConverter interface {
	ToPB(context.Context) (protobom.Document, error)
}

type PBToORMConverter

type PBToORMConverter interface {
	ToORM(context.Context) (protobom.DocumentORM, error)
}