Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Install as a dotnet tool
  2. Changed the execution syntax to use verbs (examples below)
  3. Now contains full Admin and Security databases
  4. Support for deploying Change Queries as a feature
  5. Support for deploying extensions
  6. Support for testing if any migration scripts need to be run, using whatif  verb.

Installing Alpha 2

See readme for more details.

Install the pre-compiled version from binaries on MyGet using `dotnet tool` globall dotnet tool  global installation with `--version 1.0.0-*` for   for getting the latest pre-release version:

...

The command syntax has shifted to use a verb format to indicate what action to take. This paves the way for some future verbs. The key verb for deployment is `deploy` deploy , which will run the DbUp-based migrations. There is also a new argument flag ( `-d` or `d  or --databaseType`databaseType) to indicate which database you wish to install (Admin, ODS, or Security). For example, assuming `dotnet dotnet tool install` was install  was run as shown above, the following command will install the Admin database on Postgres:

...

Change queries support is only for SQL Server at this time. Use argument `-f Changes` to Changes  to install.

Code Block
EdFi.Db.Deploy deploy -d ODS -c "server=localhost;database=EdFi_ODS;integrated security=sspi" -p SqlServer -f Changes

...

While RoadRunner will not officially support extensions, this tool will be incorporated into initdev in the near future and must be able to install extensions for SQL Server-based ODS implementations. Use argument `-x` to x  to deploy extensions, providing a list of "supporting artifacts" directories.

Code Block
$supportingArtifacts = @(
  "C:\Source\3.x\Ed-Fi-Ods-Implementation\Application\EdFi.Ods.Extensions.GrandBend\SupportingArtifacts\Database",
  "C:\Source\3.x\Ed-Fi-Ods-Implementation\Application\EdFi.Ods.Extensions.Sample\SupportingArtifacts\Database"
)

EdFi.Db.Deploy deploy -d ODS -c "server=localhost;database=EdFi_ODS;integrated security=sspi" -p SqlServer -x $supportingArtifacts

WhatIf Verb

The whatif  verb checks to see if any scripts need to be installed without performing the installation. This functionality was added to support scenarios where you want to run a task before deploying new migration scripts to the database (e.g. run a backup). Exits with status code 1 if there are migration scripts to execute and 0 otherwise.

Code Block
EdFi.Db.Deploy whatif -d ODS -c "server=localhost;database=EdFi_ODS;integrated security=sspi" -p SqlServer

# Check $LASTEXITCODE for 1 or 0

Coming Soon

ODS/API changes to support authentication and authorization will be available in the next preview release, along with instructions on manually creating a Vendor key and secret in PostgreSQL.

...