Method store

beets/dbcore/db.py:590–634

Save the object's metadata into the library database. :param fields: the fields to be stored. If not specified, all fields will be.

(self, fields: Iterable[str] | None = None)

    # Database interaction (CRUD methods).

    def store(self, fields: Iterable[str] | None = None):
        """Save the object's metadata into the library database.
        :param fields: the fields to be stored. If not specified, all fields
        will be.
        """
        if fields is None:
            fields = self._fields

        # Build assignments for query.
        assignments = []
        subvars: list[SQLiteType] = []
        for key in fields:
            if key != "id" and key in self._dirty:
                self._dirty.remove(key)
                assignments.append(f"{key}=?")
                value = self._type(key).to_sql(self[key])
                subvars.append(value)

        with self.db.transaction() as tx:
            # Main table update.
            if assignments:
                query = f"UPDATE {self._table} SET {','.join(assignments)} WHERE id=?"
                subvars.append(self.id)
                tx.mutate(query, subvars)

            # Modified/added flexible attributes.
            for key, value in self._values_flex.items():
                if key in self._dirty:
                    self._dirty.remove(key)
                    value = self._type(key).to_sql(value)
                    tx.mutate(
                        f"INSERT INTO {self._flex_table} "
                        "(entity_id, key, value) "
                        "VALUES (?, ?, ?);",
                        (self.id, key, value),
                    )

            # Deleted flexible attributes.
            for key in self._dirty:
                tx.mutate(
                    f"DELETE FROM {self._flex_table} WHERE entity_id=? AND key=?",
                    (self.id, key),
                )

        self.clear_dirty()

    def load(self):
        """Refresh the object's metadata from the library database.