pyliquibase

https://memiiso.github.io/pyliquibase/
Admin
pyliquibase is a Python module that integrates Liquibase using the Java Native Interface (JNI),...
Tokens:1,117
Snippets:24
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Check Java installation

Source: https://memiiso.github.io/pyliquibase/installation

Verify that Java is installed and configured on the system.

```bash
java -version
```

--------------------------------

### Verify pyliquibase installation

Source: https://memiiso.github.io/pyliquibase/installation?q=

Run this command to confirm the tool is correctly installed and accessible in your environment.

```bash
pyliquibase --version
```

--------------------------------

### Install pyliquibase via pip

Source: https://memiiso.github.io/pyliquibase/installation?q=

Use this command to install the package from the Python Package Index.

```bash
pip install pyliquibase
```

--------------------------------

### Initialize and Run Basic Python API

Source: https://memiiso.github.io/pyliquibase/usage

Initialize the Pyliquibase object with a properties file and execute standard migration commands.

```python
from pyliquibase import Pyliquibase

if __name__ == '__main__':
    # Initialize with a properties file
    liquibase = Pyliquibase(defaultsFile="changelogs/liquibase.properties")

    # Optionally add arguments such as log-level or log-file
    liquibase.addarg("--log-level", "info")

    # Execute specific commands
    liquibase.status()
    liquibase.validate()
    liquibase.update()
```

--------------------------------

### Run Liquibase CLI Commands

Source: https://memiiso.github.io/pyliquibase/usage

Execute standard Liquibase commands from the shell using a properties file.

```bash
pyliquibase --defaultsFile=changelogs/liquibase.properties status
pyliquibase --defaultsFile=changelogs/liquibase.properties validate
pyliquibase --defaultsFile=changelogs/liquibase.properties updateSQL
pyliquibase --defaultsFile=changelogs/liquibase.properties update
```

--------------------------------

### Visualize pyliquibase architecture

Source: https://memiiso.github.io/pyliquibase

A Mermaid diagram illustrating the integration flow from Python scripts to the target database.

```mermaid
graph TD
    A[Python Script] --> B[pyliquibase API]
    B --> C[JPype JNI Bridge]
    C --> D[Java Virtual Machine]
    D --> E[Liquibase Java Core]
    E --> F[Target Database]
```

--------------------------------

### Advanced Python API Execution

Source: https://memiiso.github.io/pyliquibase/usage

Use the generic execute method for custom commands or utilize specific helper methods for maintenance and rollback tasks.

```python
# Call execute with arguments
liquibase.execute("status")
liquibase.execute("rollback", "MyTag")

# Specific helper methods
liquibase.update_to_tag("MyTag")
liquibase.rollback("MyTag")

# Maintenance commands
liquibase.changelog_sync()
liquibase.clear_checksums()
liquibase.release_locks()
```
Tokens:
Raw