Method save

piccolo/table.py:490–546

A proxy to an insert or update query. :param columns: Only the specified columns will be synced back to the database when doing an update. For example: .. code-block:: python band = await Band.objects().first() b

(
        self, columns: Optional[Sequence[Union[Column, str]]] = None
    )

    ###########################################################################

    def save(
        self, columns: Optional[Sequence[Union[Column, str]]] = None
    ) -> Union[Insert, Update]:
        """
        A proxy to an insert or update query.

        :param columns:
            Only the specified columns will be synced back to the database
            when doing an update. For example:

            .. code-block:: python

                band = await Band.objects().first()
                band.popularity = 2000
                await band.save(columns=[Band.popularity])

            If ``columns=None`` (the default) then all columns will be synced
            back to the database.

        """
        cls = self.__class__

        # New row - insert
        if not self._exists_in_db:
            return cls.insert(self).returning(cls._meta.primary_key)

        # Pre-existing row - update
        if columns is None:
            column_instances = [
                i for i in cls._meta.columns if not i._meta.primary_key
            ]
        else:
            column_instances = [
                self._meta.get_column_by_name(i) if isinstance(i, str) else i
                for i in columns
            ]

        values: dict[Column, Any] = {
            i: getattr(self, i._meta.name, None) for i in column_instances
        }

        # Assign any `auto_update` values
        if cls._meta.auto_update_columns:
            auto_update_values = cls._meta.get_auto_update_values()
            values.update(auto_update_values)
            for column, value in auto_update_values.items():
                setattr(self, column._meta.name, value)

        return cls.update(
            values,  # type: ignore
            # We've already included the `auto_update` columns, so no need
            # to do it again:
            use_auto_update=False,
        ).where(
            cls._meta.primary_key
            == getattr(self, self._meta.primary_key._meta.name)
        )