Struct AlterTableProcedure

pub struct AlterTableProcedure {
    context: DdlContext,
    data: AlterTableData,
    new_table_info: Option<TableInfo>,
}

The alter table procedure

Fields

context: DdlContext

The runtime context.

data: AlterTableData

The serialized data.

new_table_info: Option<TableInfo>

Cached new table metadata in the prepare step. If we recover the procedure from json, then the table info value is not cached. But we already validated it in the prepare step.

Implementations

impl AlterTableProcedure

pub(crate) async fn check_alter(&self) -> Result<()>

Checks:

• The new table name doesn’t exist (rename).
• Table exists.

impl AlterTableProcedure

pub(crate) async fn fill_table_info(&mut self) -> Result<()>

Fetches the table info.

impl AlterTableProcedure

pub(crate) fn make_alter_region_request( &self, region_id: RegionId, kind: Option<Kind>, ) -> Result<RegionRequest>

Makes alter region request from existing an alter kind. Region alter request always add columns if not exist.

pub(crate) fn make_region_alter_kind(&self) -> Result<Option<Kind>>

Makes alter kind proto that all regions can reuse. Region alter request always add columns if not exist.

impl AlterTableProcedure

pub(crate) fn build_new_table_info( &self, table_info: &RawTableInfo, ) -> Result<TableInfo>

Builds new table info after alteration. It bumps the column id of the table by the number of the add column requests. So there may be holes in the column id sequence.

pub(crate) async fn on_update_metadata_for_rename( &self, new_table_name: String, current_table_info_value: &DeserializedValueWithBytes<TableInfoValue>, ) -> Result<()>

Updates table metadata for rename table operation.

pub(crate) async fn on_update_metadata_for_alter( &self, new_table_info: RawTableInfo, region_distribution: RegionDistribution, current_table_info_value: &DeserializedValueWithBytes<TableInfoValue>, ) -> Result<()>

Updates table metadata for alter table operation.

impl AlterTableProcedure

pub const TYPE_NAME: &'static str = "metasrv-procedure::AlterTable"

pub fn new( cluster_id: ClusterId, table_id: TableId, task: AlterTableTask, context: DdlContext, ) -> Result<Self>

pub fn from_json(json: &str, context: DdlContext) -> ProcedureResult<Self>

pub(crate) async fn on_prepare(&mut self) -> Result<Status>

pub async fn submit_alter_region_requests(&mut self) -> Result<Status>

pub(crate) async fn on_update_metadata(&mut self) -> Result<Status>

Update table metadata.

async fn on_broadcast(&mut self) -> Result<Status>

Broadcasts the invalidating table cache instructions.

fn lock_key_inner(&self) -> Vec<StringKey>

Trait Implementations

impl Procedure for AlterTableProcedure

fn type_name(&self) -> &str

Type name of the procedure.

fn execute<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 ProcedureContext, ) -> Pin<Box<dyn Future<Output = ProcedureResult<Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the procedure.

fn dump(&self) -> ProcedureResult<String>

Dump the state of the procedure to a string.

fn lock_key(&self) -> LockKey

Returns the [LockKey] that this procedure needs to acquire.

fn rollback<'life0, 'life1, 'async_trait>( &'life0 mut self, _: &'life1 Context, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Rollback the failed procedure.

fn rollback_supported(&self) -> bool

Indicates whether it supports rolling back the procedure.

fn recover(&mut self) -> Result<(), Error>

The hook is called after the procedure recovery.