com.zepben.evolve.database.sqlite.cim.metadata.MetadataEntryWriter.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation

SDK for interaction with the evolve platform

There is a newer version: 0.24.0rc1

/*
 * Copyright 2024 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.database.sqlite.cim.metadata

import com.zepben.evolve.database.sqlite.cim.CimDatabaseTables
import com.zepben.evolve.database.sqlite.common.BaseEntryWriter
import com.zepben.evolve.database.sqlite.extensions.logFailure
import com.zepben.evolve.database.sqlite.extensions.setInstant
import com.zepben.evolve.database.sqlite.extensions.tryExecuteSingleUpdate
import com.zepben.evolve.database.sqlite.cim.tables.TableMetadataDataSources
import com.zepben.evolve.services.common.meta.DataSource
import com.zepben.evolve.services.common.meta.MetadataCollection
import org.slf4j.Logger
import org.slf4j.LoggerFactory

/**
 * A class for reading the [MetadataCollection] entries from the database.
 *
 * @param databaseTables The tables that are available in the database.
 */
class MetadataEntryWriter(
    val databaseTables: CimDatabaseTables
) : BaseEntryWriter() {

    private val logger: Logger = LoggerFactory.getLogger(javaClass)

    /**
     * Save the [DataSource] fields to [TableMetadataDataSources].
     *
     * @param dataSource The [DataSource] to save to the database.
     *
     * @return true if the [DataSource] is successfully written to the database, otherwise false.
     */
    fun save(dataSource: DataSource): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        insert.setString(table.SOURCE.queryIndex, dataSource.source)
        insert.setString(table.VERSION.queryIndex, dataSource.version)
        insert.setInstant(table.TIMESTAMP.queryIndex, dataSource.timestamp)

        return insert.tryExecuteSingleUpdate { insert.logFailure(logger, "data source") }
    }

}