Safe Haskell	None
Language	Haskell2010

Hasura.RQL.DDL.Schema.Rename

Description

Functions for updating the metadata (with integrity checking) to incorporate schema changes discovered after applying a user-supplied SQL query. None of these functions modify the schema cache, so it must be reloaded after the metadata is updated.

Synopsis

data RenameItem (b :: BackendType) a = RenameItem {
- _riTable :: TableName b
- _riOld :: a
- _riNew :: a
}
type RenameCol (b :: BackendType) = RenameItem b (Column b)
data RenameField b
- = RFCol (RenameCol b)
- | RFRel (RenameItem b RelName)
type RenameTable b = (TableName b, TableName b)
data Rename b
- = RTable (RenameTable b)
- | RField (RenameField b)
otherDeps :: QErrM m => Text -> SchemaObjId -> m ()
renameTableInMetadata :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> TableName b -> m ()
renameColumnInMetadata :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => Column b -> Column b -> SourceName -> TableName b -> FieldInfoMap (FieldInfo b) -> m ()
renameRelationshipInMetadata :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RelName -> RelType -> RelName -> m ()
updateRelDefs :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RelName -> RenameTable b -> m ()
updatePermFlds :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RoleName -> PermType -> Rename b -> m ()
updateInsPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b InsPerm -> m (PermDefPermission b InsPerm)
updateSelPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b SelPerm -> m (PermDefPermission b SelPerm)
updateUpdPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b UpdPerm -> m (PermDefPermission b UpdPerm)
updateDelPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b DelPerm -> m (PermDefPermission b DelPerm)
updatePreset :: Backend b => TableName b -> RenameField b -> ColumnValues b Value -> ColumnValues b Value
updateCols :: Backend b => TableName b -> RenameField b -> PermColSpec b -> PermColSpec b
updateTableInBoolExp :: Backend b => RenameTable b -> BoolExp b -> BoolExp b
updateFieldInBoolExp :: (MonadReader (TableCache b) m, Backend b) => TableName b -> RenameField b -> BoolExp b -> m (BoolExp b)
updateColExp :: forall b m. (MonadReader (TableCache b) m, Backend b) => TableName b -> RenameField b -> ColExp -> m ColExp
updateColInRel :: forall b m. (CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RelName -> RenameCol b -> m ()
updateColInRemoteRelationshipLHS :: forall b m. (MonadError QErr m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> RelName -> RenameCol b -> m ()
updateColInRemoteRelationshipRHS :: forall source target m. (MonadWriter MetadataModifier m, Backend source, Backend target) => SourceName -> TableName source -> RelName -> RenameCol target -> m ()
updateTableInRemoteRelationshipRHS :: forall source target m. (MonadWriter MetadataModifier m, Backend source, Backend target) => SourceName -> TableName source -> RelName -> RenameTable target -> m ()
updateColInObjRel :: Backend b => TableName b -> TableName b -> RenameCol b -> ObjRelUsing b -> ObjRelUsing b
updateRelChoice :: Backend b => TableName b -> TableName b -> RenameCol b -> ObjRelUsingChoice b -> ObjRelUsingChoice b
updateColInArrRel :: Backend b => TableName b -> TableName b -> RenameCol b -> ArrRelUsing b -> ArrRelUsing b
type ColMap b = HashMap (Column b) (Column b)
getNewCol :: forall b f. Backend b => Functor f => RenameCol b -> TableName b -> f (Column b) -> f (Column b)
updateRelManualConfig :: forall b. Backend b => TableName b -> TableName b -> RenameCol b -> RelManualConfig b -> RelManualConfig b
updateColMap :: forall b. Backend b => TableName b -> TableName b -> RenameCol b -> ColMap b -> ColMap b
possiblyUpdateCustomColumnNames :: forall b m. (MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> Column b -> Column b -> m ()

Documentation

data RenameItem (b :: BackendType) a Source #

Constructors

RenameItem
Fields _riTable :: TableName b _riOld :: a _riNew :: a

type RenameCol (b :: BackendType) = RenameItem b (Column b) Source #

data RenameField b Source #

Constructors

RFCol (RenameCol b)
RFRel (RenameItem b RelName)

type RenameTable b = (TableName b, TableName b) Source #

data Rename b Source #

Constructors

RTable (RenameTable b)
RField (RenameField b)

otherDeps :: QErrM m => Text -> SchemaObjId -> m () Source #

renameTableInMetadata :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> TableName b -> m () Source #

Replace all references to a given table name by its new name across the entire metadata.

This function will make use of the metadata dependency graph (see getDependentObjs) to identify all places that refer to the old table name, and replace it accordingly. Most operations will occur within the same source, such as table references in relationships and permissions. Dependencies across sources can happen in the case of cross-source relationships.

This function will fail if it encounters a nonsensical dependency; for instance, if there's a dependency from that table to a source.

For more information about the dependency graph, see SchemaObjId.

renameColumnInMetadata :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => Column b -> Column b -> SourceName -> TableName b -> FieldInfoMap (FieldInfo b) -> m () Source #

Replace all references to a given column name by its new name across the entire metadata.

This function will make use of the metadata dependency graph (see getDependentObjs) to identify all places that refer to the old column name, and replace it accordingly. Most operations will occur within the same source, such as column references in relationships and permissions. Dependencies across sources can happen in the case of cross-source relationships.

This function will fail if it encounters a nonsensical dependency; for instance, if there's a dependency from that table to a source.

For more information about the dependency graph, see SchemaObjId.

renameRelationshipInMetadata :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RelName -> RelType -> RelName -> m () Source #

updateRelDefs :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RelName -> RenameTable b -> m () Source #

updatePermFlds :: forall b m. (MonadError QErr m, CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RoleName -> PermType -> Rename b -> m () Source #

update fields in permissions

updateInsPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b InsPerm -> m (PermDefPermission b InsPerm) Source #

updateSelPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b SelPerm -> m (PermDefPermission b SelPerm) Source #

updateUpdPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b UpdPerm -> m (PermDefPermission b UpdPerm) Source #

updateDelPermFlds :: (MonadReader (TableCache b) m, Backend b) => TableName b -> Rename b -> PermDefPermission b DelPerm -> m (PermDefPermission b DelPerm) Source #

updatePreset :: Backend b => TableName b -> RenameField b -> ColumnValues b Value -> ColumnValues b Value Source #

updateCols :: Backend b => TableName b -> RenameField b -> PermColSpec b -> PermColSpec b Source #

updateTableInBoolExp :: Backend b => RenameTable b -> BoolExp b -> BoolExp b Source #

updateFieldInBoolExp :: (MonadReader (TableCache b) m, Backend b) => TableName b -> RenameField b -> BoolExp b -> m (BoolExp b) Source #

updateColExp :: forall b m. (MonadReader (TableCache b) m, Backend b) => TableName b -> RenameField b -> ColExp -> m ColExp Source #

updateColInRel :: forall b m. (CacheRM m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> RelName -> RenameCol b -> m () Source #

updateColInRemoteRelationshipLHS :: forall b m. (MonadError QErr m, MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> RelName -> RenameCol b -> m () Source #

Local helper: update a column's name in the left-hand side of a remote relationship.

There are two kinds or remote relationships: remote source relationships, across sources, and remote schema relationships, on remote schemas. In both cases, we maintain a mapping from the source table's colunns to what they should be joined against in the target; when a column is renamed, those references must be renamed as well. This function handles both cases.

See renameColumnInMetadata.

updateColInRemoteRelationshipRHS :: forall source target m. (MonadWriter MetadataModifier m, Backend source, Backend target) => SourceName -> TableName source -> RelName -> RenameCol target -> m () Source #

Local helper: update a column's name in the right-hand side of a remote relationship.

In the case of remote _source_ relationships, the mapping from column to column needs to be updated if one of the rhs columns has been renamed. A dependency is tracked from the rhs source's column to the lhs source's relationship: when a rhs source's column has been renamed, this function performs the corresponding update in the lhs source's relationship definition.

See renameColumnInMetadata.

updateTableInRemoteRelationshipRHS :: forall source target m. (MonadWriter MetadataModifier m, Backend source, Backend target) => SourceName -> TableName source -> RelName -> RenameTable target -> m () Source #

Local helper: update a table's name in the right-hand side of a remote relationship.

In the case of remote _source_ relationships, the relationship definition targets a specific table in the rhs source, and that reference needs to be updated if the targeted table has been renamed. A dependency is tracked from the rhs source's table to the lhs source's relationship: when a rhs table has been renamed, this function performs the corresponding update in the lhs source's relationship definition.

See renameTableInMetadata.

updateColInObjRel :: Backend b => TableName b -> TableName b -> RenameCol b -> ObjRelUsing b -> ObjRelUsing b Source #

updateRelChoice :: Backend b => TableName b -> TableName b -> RenameCol b -> ObjRelUsingChoice b -> ObjRelUsingChoice b Source #

updateColInArrRel :: Backend b => TableName b -> TableName b -> RenameCol b -> ArrRelUsing b -> ArrRelUsing b Source #

type ColMap b = HashMap (Column b) (Column b) Source #

getNewCol :: forall b f. Backend b => Functor f => RenameCol b -> TableName b -> f (Column b) -> f (Column b) Source #

updateRelManualConfig :: forall b. Backend b => TableName b -> TableName b -> RenameCol b -> RelManualConfig b -> RelManualConfig b Source #

updateColMap :: forall b. Backend b => TableName b -> TableName b -> RenameCol b -> ColMap b -> ColMap b Source #

possiblyUpdateCustomColumnNames :: forall b m. (MonadWriter MetadataModifier m, BackendMetadata b) => SourceName -> TableName b -> Column b -> Column b -> m () Source #