IMiMigrationSerializer (Migrondi)

IMiMigrationSerializer Type

Namespace: Migrondi.Core.Serialization
Assembly: Migrondi.Core.dll
Base Type: obj
All Interfaces: IMiMigrationSerializer

This service is responsible for serializing and deserializing the migration files. The default implementation coordinates between the v0.x and the v1.x formats to provide backwards compatibility.

Instance members

Instance member Description


                
                  
                    
                      this.DecodeJson

Full Usage: this.DecodeJson

Parameters:

content : string - The string to deserialize

Returns: Migration A Result that may contain a Migration object or a SerializationError
Modifiers: abstract

Takes a string and returns a Migration object

The string is the content of the migration file

content : string: The string to deserialize

Returns: Migration: A Result that may contain a Migration object or a SerializationError

DeserializationFailed

Thrown when the serialization fails


                
                  
                    
                      this.DecodeMigrationRecord

Full Usage: this.DecodeMigrationRecord

Parameters:

content : string - The string to deserialize

Returns: MigrationRecord A Result that may contain a MigrationRecord object or a SerializationError
Modifiers: abstract

Takes a string and returns a MigrationRecord object

The string is the content of the migration file

content : string: The string to deserialize

Returns: MigrationRecord: A Result that may contain a MigrationRecord object or a SerializationError

DeserializationFailed

Thrown when the serialization fails


                
                  
                    
                      this.DecodeText

Full Usage: this.DecodeText

Parameters:

content : string - The string to deserialize

?migrationName : string - Optional migration name in case we're decoding v0 migrations format

Returns: Migration A Result that may contain a Migration object or a SerializationError
Modifiers: abstract

Takes a string and returns a Migration object

The string is the content of the migration file

content : string: The string to deserialize
?migrationName : string: Optional migration name in case we're decoding v0 migrations format

Returns: Migration: A Result that may contain a Migration object or a SerializationError

DeserializationFailed

Thrown when the serialization fails


                
                  
                    
                      this.EncodeJson

Full Usage: this.EncodeJson

Parameters:

content : Migration - The Migration object to serialize

Returns: string A string
Modifiers: abstract

Takes a Migration object and returns a string

The string is the content of the migration file

content : Migration: The Migration object to serialize

Returns: string: A string


                
                  
                    
                      this.EncodeMigrationRecord

Full Usage: this.EncodeMigrationRecord

Parameters:

content : MigrationRecord - The MigrationRecord object to serialize

Returns: string A string
Modifiers: abstract

Takes a MigrationRecord object and returns a string

The string is the content of the migration file

content : MigrationRecord: The MigrationRecord object to serialize

Returns: string: A string


                
                  
                    
                      this.EncodeText

Full Usage: this.EncodeText

Parameters:

content : Migration - The Migration object to serialize

Returns: string A string
Modifiers: abstract

Takes a Migration object and returns a string

The string is the content of the migration file

content : Migration: The Migration object to serialize

Returns: string: A string