Ready to get started?

Learn more about the Alfresco PowerShell Cmdlets or download a free trial:

Download Now

PowerShell Scripting to Replicate Alfresco Data to MySQL

Write a simple PowerShell script to replicate Alfresco data to a MySQL database.

The CData Cmdlets for Alfresco offer live access to Alfresco data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Alfresco and the CData Cmdlets for MySQL in PowerShell to replicate Alfresco data to a MySQL database.

After obtaining the needed connection properties, accessing Alfresco data in PowerShell and preparing for replication consists of four basic steps.

To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

Collecting Alfresco Data

  1. Install the module:

    Install-Module AlfrescoCmdlets
  2. Connect to Alfresco:

    $alfresco = Connect-Alfresco -User $User -Password $Password -Format $Format -InstanceUrl $InstanceUrl
  3. Retrieve the data from a specific resource:

    $data = Select-Alfresco -Connection $alfresco -Table "Alfresco"

    You can also use the Invoke-Alfresco cmdlet to execute pure SQL-92 statements:

    $data = Invoke-Alfresco -Connection $alfresco -Query 'SELECT * FROM Alfresco WHERE Column2 = @Column2' -Params @{'@Column2'='MyFilter'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting Alfresco Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the Alfresco data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Alfresco resource (Alfresco) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Alfresco" -Columns $columns -Values $values }

You have now replicated your Alfresco data to a MySQL database. This gives you freedom to work with Alfresco data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

  • Once you have connected to Alfresco and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-Alfresco -Connection $alfresco -Table "Alfresco" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Alfresco" -Columns $columns -Values $values }
  • If you wish to replicate the Alfresco data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-Alfresco cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}