Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#

[bumpversion]
current_version = 5.1.0
current_version = 5.2.0
commit = False
tag = False
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<dev>\d+))?
Expand Down
4 changes: 2 additions & 2 deletions common/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "dvp-common"
version = "5.1.0"
version = "5.2.0"
readme = "README.md"
requires-python = ">=3.11, <3.12"
authors = [
Expand All @@ -23,7 +23,7 @@ classifiers = [
"Operating System :: OS Independent",
]
dependencies = [
"dvp-api == 1.10.0",
"dvp-api == 1.11.0.dev0",
"six >= 1.17, < 1.18",
]

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/References/Decorators.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Plugin Operation | Decorator
[Direct Linked Source Pre-Snapshot](Plugin_Operations.md#direct-linked-source-pre-snapshot) | `@plugin.linked.pre_snapshot()`
[Direct Linked Source Post-Snapshot](Plugin_Operations.md#direct-linked-source-post-snapshot) | `@plugin.linked.post_snapshot()`
[Direct Linked Source Size](Plugin_Operations.md#direct-linked-source-size) | `@plugin.linked.source_size()`
[Direct Linked Source Pre-Source-to-Physical](Plugin_Operations.md#direct-linked-source-pre-source-to-physical) | `@plugin.linked.pre_source_to_physical()`
[Direct Linked Source to Physical](Plugin_Operations.md#direct-linked-source-to-physical) | `@plugin.linked.source_to_physical()`
[Staged Linked Source Pre-Snapshot](Plugin_Operations.md#staged-linked-source-pre-snapshot) | `@plugin.linked.pre_snapshot()`
[Staged Linked Source Post-Snapshot](Plugin_Operations.md#staged-linked-source-post-snapshot) | `@plugin.linked.post_snapshot()`
Expand All @@ -37,6 +38,7 @@ Plugin Operation | Decorator
[Staged Linked Source Worker](Plugin_Operations.md#staged-linked-source-worker) | `@plugin.linked.worker()`
[Staged Linked Source Mount Specification](Plugin_Operations.md#staged-linked-source-mount-specification) | `@plugin.linked.mount_specification()`
[Staged Linked Source Size](Plugin_Operations.md#staged-linked-source-size) | `@plugin.linked.source_size()`
[Staged Linked Source Pre-Source-to-Physical](Plugin_Operations.md#staged-linked-source-pre-source-to-physical) | `@plugin.linked.pre_source_to_physical()`
[Staged Linked Source to Physical](Plugin_Operations.md#staged-linked-source-to-physical) | `@plugin.linked.source_to_physical()`
[Virtual Source Configure](Plugin_Operations.md#virtual-source-configure) | `@plugin.virtual.configure()`
[Virtual Source Initialize](Plugin_Operations.md#virtual-source-initialize) | `@plugin.virtual.initialize()`
Expand All @@ -50,6 +52,7 @@ Plugin Operation | Decorator
[Virtual Source Mount Specification](Plugin_Operations.md#virtual-source-mount-specification) | `@plugin.virtual.mount_specification()`
[Virtual Source Status](Plugin_Operations.md#virtual-source-status) | `@plugin.virtual.status()`
[Virtual Source Size](Plugin_Operations.md#virtual-source-size) | `@plugin.virtual.source_size()`
[Virtual Source Pre-Source-to-Physical](Plugin_Operations.md#virtual-source-pre-source-to-physical) | `@plugin.virtual.pre_source_to_physical()`
[Virtual Source to Physical](Plugin_Operations.md#virtual-source-to-physical) | `@plugin.virtual.source_to_physical()`
[Repository Data Migration](Plugin_Operations.md#repository-data-migration) | `@plugin.upgrade.repository(migration_id)`
[Source Config Data Migration](Plugin_Operations.md#source-config-data-migration) | `@plugin.upgrade.source_config(migration_id)`
Expand Down
141 changes: 141 additions & 0 deletions docs/docs/References/Plugin_Operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Plugin Operation | **Required** | Decorator | Delphix Engine Operations
[Direct Linked Source<br/>Pre-Snapshot](#direct-linked-source-pre-snapshot) | **No** | `linked.pre_snapshot()` | [Linked Source Sync](Workflows.md#linked-source-sync)
[Direct Linked Source<br/>Post-Snapshot](#direct-linked-source-post-snapshot) | **Yes** | `linked.post_snapshot()` | [Linked Source Sync](Workflows.md#linked-source-sync)
[Direct Linked Source<br/>Source Size](#direct-linked-source-size) | **No** | `linked.source_size()` | N/A
[Direct Linked Source<br/>Pre-Source-to-Physical](#direct-linked-source-pre-source-to-physical) | **No** | `linked.pre_source_to_physical()` | [Linked Source to Physical](Workflows.md#linked-source-to-physical)
[Direct Linked Source<br/>to Physical](#direct-linked-source-to-physical) | **No** | `linked.source_to_physical()` | [Linked Source to Physical](Workflows.md#linked-source-to-physical)
[Staged Linked Source<br/>Pre-Snapshot](#staged-linked-source-pre-snapshot) | **No** | `linked.pre_snapshot()` | [Linked Source Sync](Workflows.md#linked-source-sync)
[Staged Linked Source<br/>Post-Snapshot](#staged-linked-source-post-snapshot) | **Yes** | `linked.post_snapshot()` | [Linked Source Sync](Workflows.md#linked-source-sync)
Expand All @@ -24,6 +25,7 @@ Plugin Operation | **Required** | Decorator | Delphix Engine Operations
[Staged Linked Source<br/>Worker](#staged-linked-source-worker) | **No** |`linked.worker()` | N/A
[Staged Linked Source<br/>Mount Specification](#staged-linked-source-mount-specification) | **Yes** | `linked.mount_specification()` | [Linked Source Sync](Workflows.md#linked-source-sync)<br/>[Linked Source Enable](Workflows.md#linked-source-enable)
[Staged Linked Source<br/>Source Size](#staged-linked-source-size) | **No** | `linked.source_size()` | N/A
[Staged Linked Source<br/>Pre-Source-to-Physical](#staged-linked-source-pre-source-to-physical) | **No** | `linked.pre_source_to_physical()` | [Linked Source to Physical](Workflows.md#linked-source-to-physical)
[Staged Linked Source<br/>to Physical](#staged-linked-source-to-physical) | **No** | `linked.source_to_physical()` | [Linked Source to Physical](Workflows.md#linked-source-to-physical)
[Virtual Source<br/>Initialize](#virtual-source-initialize) | **No** | `virtual.initialize()` | [Virtual Source Create Empty VDB](Workflows.md#virtual-source-create-empty-vdb)
[Virtual Source<br/>Configure](#virtual-source-configure) | **Yes** | `virtual.configure()` | [Virtual Source Provision](Workflows.md#virtual-source-provision)<br/>[Virtual Source Refresh](Workflows.md#virtual-source-refresh)
Expand All @@ -37,6 +39,7 @@ Plugin Operation | **Required** | Decorator | Delphix Engine Operations
[Virtual Source<br>Mount Specification](#virtual-source-mount-specification) | **Yes** | `virtual.mount_specification()` | [Virtual Source Enable](Workflows.md#virtual-source-enable)<br/>[Virtual Source Provision](Workflows.md#virtual-source-provision)<br/>[Virtual Source Refresh](Workflows.md#virtual-source-refresh)<br/>[Virtual Source Rollback](Workflows.md#virtual-source-rollback)<br/>[Virtual Source Start](Workflows.md#virtual-source-start)
[Virtual Source<br/>Status](#virtual-source-status) | **No** | `virtual.status()` | [Virtual Source Enable](Workflows.md#virtual-source-enable)
[Virtual Source<br/>Source Size](#virtual-source-size) | **No** | `virtual.source_size()` | N/A
[Virtual Source<br/>Pre-Source-to-Physical](#virtual-source-pre-source-to-physical) | **No** | `virtual.pre_source_to_physical()` | [Virtual Source to Physical](Workflows.md#virtual-source-to-physical)
[Virtual Source<br/>to Physical](#virtual-source-to-physical) | **No** | `virtual.source_to_physical()` | [Virtual Source to Physical](Workflows.md#virtual-source-to-physical)
[Repository Data Migration](#repository-data-migration) | **No** | `upgrade.repository(migration_id)` | [Upgrade](Workflows.md#upgrade)
[Source Config Data Migration](#source-config-data-migration) | **No** | `upgrade.source_config(migration_id)` | [Upgrade](Workflows.md#upgrade)
Expand Down Expand Up @@ -316,6 +319,52 @@ def linked_source_size(direct_source, repository, source_config):
return database_size
```

## Direct Linked Source Pre-Source-to-Physical

Executed immediately before the file-copy for a [Linked Source to Physical](Workflows.md#linked-source-to-physical) workflow begins, giving a plugin the chance to reject an unsuitable target before any data moves. Its post-copy counterpart is [Direct Linked Source to Physical](#direct-linked-source-to-physical).

### Required / Optional
**Optional.**

### Delphix Engine Operations

* [Linked Source to Physical](Workflows.md#linked-source-to-physical)

### Signature

`def direct_pre_source_to_physical(direct_source, repository, source_config, snapshot, physical_source)`

### Decorator

`linked.pre_source_to_physical()`

### Arguments

Argument | Type | Description
-------- | ---- | -----------
direct_source | [DirectSource](Classes.md#directsource) | The direct linked source being exported.
repository | [RepositoryDefinition](Schemas_and_Autogenerated_Classes.md#repositorydefinition-class) | The repository associated with this source.
source_config | [SourceConfigDefinition](Schemas_and_Autogenerated_Classes.md#sourceconfigdefinition-class) | The source config associated with this source.
snapshot | [SnapshotDefinition](Schemas_and_Autogenerated_Classes.md#snapshotdefinition-class) | The snapshot being exported.
physical_source | [PhysicalSource](Classes.md#physicalsource) | The target physical source, including connection, target directory, and user-defined parameters from the [VirtualToPhysicalDefinition](Schemas_and_Autogenerated_Classes.md#virtualtophysicaldefinition-class).

### Returns
None

### Example

```python
from dlpx.virtualization.platform import Plugin

plugin = Plugin()

@plugin.linked.pre_source_to_physical()
def direct_pre_source_to_physical(direct_source, repository, source_config, snapshot, physical_source):
target_dir = physical_source.target_directory
# Validate target_dir is suitable before the copy begins; raise to abort the copy.
pass
```

## Direct Linked Source to Physical

Converts a [Direct Linked Source](Glossary.md#direct-linking) to a physical source. Only applies when a physical export is requested on a dSource using a [Direct Linking](Glossary.md#direct-linking) strategy.
Expand Down Expand Up @@ -739,6 +788,52 @@ def linked_source_size(staged_source, repository, source_config):
return database_size
```

## Staged Linked Source Pre-Source-to-Physical

Executed immediately before the file-copy for a [Linked Source to Physical](Workflows.md#linked-source-to-physical) workflow begins, giving a plugin the chance to reject an unsuitable target before any data moves. Its post-copy counterpart is [Staged Linked Source to Physical](#staged-linked-source-to-physical).

### Required / Optional
**Optional.**

### Delphix Engine Operations

* [Linked Source to Physical](Workflows.md#linked-source-to-physical)

### Signature

`def staged_pre_source_to_physical(staged_source, repository, source_config, snapshot, physical_source)`

### Decorator

`linked.pre_source_to_physical()`

### Arguments

Argument | Type | Description
-------- | ---- | -----------
staged_source | [StagedSource](Classes.md#stagedsource) | The staged linked source being exported.
repository | [RepositoryDefinition](Schemas_and_Autogenerated_Classes.md#repositorydefinition-class) | The repository associated with this source.
source_config | [SourceConfigDefinition](Schemas_and_Autogenerated_Classes.md#sourceconfigdefinition-class) | The source config associated with this source.
snapshot | [SnapshotDefinition](Schemas_and_Autogenerated_Classes.md#snapshotdefinition-class) | The snapshot being exported.
physical_source | [PhysicalSource](Classes.md#physicalsource) | The target physical source, including connection, target directory, and user-defined parameters from the [VirtualToPhysicalDefinition](Schemas_and_Autogenerated_Classes.md#virtualtophysicaldefinition-class).

### Returns
None

### Example

```python
from dlpx.virtualization.platform import Plugin

plugin = Plugin()

@plugin.linked.pre_source_to_physical()
def staged_pre_source_to_physical(staged_source, repository, source_config, snapshot, physical_source):
target_dir = physical_source.target_directory
# Validate target_dir is suitable before the copy begins; raise to abort the copy.
pass
```

## Staged Linked Source to Physical

Converts a [Staged Linked Source](Glossary.md#staged-linking) to a physical source. Only applies when a physical export is requested on a dSource using a [Staged Linking](Glossary.md#staged-linking) strategy.
Expand Down Expand Up @@ -1390,6 +1485,52 @@ def virtual_source_size(virtual_source, repository, source_config):
```


## Virtual Source Pre-Source-to-Physical

Executed immediately before the file-copy for a [Virtual Source to Physical](Workflows.md#virtual-source-to-physical) workflow begins, giving a plugin the chance to reject an unsuitable target before any data moves. Its post-copy counterpart is [Virtual Source to Physical](#virtual-source-to-physical).

### Required / Optional
**Optional.**

### Delphix Engine Operations

* [Virtual Source to Physical](Workflows.md#virtual-source-to-physical)

### Signature

`def virtual_pre_source_to_physical(virtual_source, repository, source_config, snapshot, physical_source)`

### Decorator

`virtual.pre_source_to_physical()`

### Arguments

Argument | Type | Description
-------- | ---- | -----------
virtual_source | [VirtualSource](Classes.md#virtualsource) | The virtual source being exported.
repository | [RepositoryDefinition](Schemas_and_Autogenerated_Classes.md#repositorydefinition-class) | The repository associated with this source.
source_config | [SourceConfigDefinition](Schemas_and_Autogenerated_Classes.md#sourceconfigdefinition-class) | The source config associated with this source.
snapshot | [SnapshotDefinition](Schemas_and_Autogenerated_Classes.md#snapshotdefinition-class) | The snapshot being exported.
physical_source | [PhysicalSource](Classes.md#physicalsource) | The target physical source, including connection, target directory, and user-defined parameters from the [VirtualToPhysicalDefinition](Schemas_and_Autogenerated_Classes.md#virtualtophysicaldefinition-class).

### Returns
None

### Example

```python
from dlpx.virtualization.platform import Plugin

plugin = Plugin()

@plugin.virtual.pre_source_to_physical()
def virtual_pre_source_to_physical(virtual_source, repository, source_config, snapshot, physical_source):
target_dir = physical_source.target_directory
# Validate target_dir is suitable before the copy begins; raise to abort the copy.
pass
```

## Virtual Source to Physical

Converts a [Virtual Source](Glossary.md#virtual-source) to a physical source. Only applies when a physical export is requested on a VDB.
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/References/Version_Compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

| vSDK Version | Earliest Supported DE Version | Latest Supported DE Version |
|------------------------------------------|:-----------------------------:|:-----------------------------------------------------------------:|
| [5.2.0](../Release_Notes/5.2.0/5.2.0.md) | 2026.5.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) |
| [5.1.0](../Release_Notes/5.1.0/5.1.0.md) | 2026.4.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) |
| [5.0.1](../Release_Notes/5.0.1/5.0.1.md) | 2025.2.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) |
| [5.0.0](../Release_Notes/5.0.0/5.0.0.md) | 29.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) |
Expand All @@ -21,6 +22,7 @@

| vSDK Version | Python Version |
|------------------------------------------|:--------------:|
| [5.2.0](../Release_Notes/5.2.0/5.2.0.md) | 3.11 |
| [5.1.0](../Release_Notes/5.1.0/5.1.0.md) | 3.11 |
| [5.0.1](../Release_Notes/5.0.1/5.0.1.md) | 3.11 |
| [5.0.0](../Release_Notes/5.0.0/5.0.0.md) | 3.11 |
Expand Down
Loading
Loading