Skip to content

Commit 85dce1e

Browse files
committed
Update documentation.
1 parent 9022556 commit 85dce1e

File tree

1 file changed

+104
-2
lines changed

1 file changed

+104
-2
lines changed

README.md

Lines changed: 104 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[![build](https://img.shields.io/travis/utPLSQL/utPLSQL-v2-v3-bridge/master.svg?label=master%20branch)](https://travis-ci.org/utPLSQL/utPLSQL-v2-v3-bridge)
2-
[![sonar](https://sonarqube.com/api/badges/gate?key=utPLSQL%3AutPLSQL-v2-v3-bridge)](https://sonarqube.com/dashboard/index?id=id=utPLSQL%3AutPLSQL-v2-v3-bridge)
1+
[![build](https://img.shields.io/travis/utPLSQL/utPLSQL-v2-v3-migration/master.svg?label=master%20branch)](https://travis-ci.org/utPLSQL/utPLSQL-v2-v3-migration)
2+
[![sonar](https://sonarqube.com/api/badges/gate?key=utPLSQL%3AutPLSQL-v2-v3-migration)](https://sonarqube.com/dashboard/index?id=id=utPLSQL%3AutPLSQL-v2-v3-migration)
33

44
# utPLSQL v2 to v3 migration utility
55

@@ -65,7 +65,109 @@ User executing the migration needs to:
6565
- be the owner of migrated packages
6666
- have `create any procedure` system privilege
6767

68+
The migration process is designed, so that after migration, you can invoke the unit tests using both:
69+
- utPLSQL v2.x framework
70+
- utPLSQL v3.x framework
71+
72+
Once migration packages were installed, you can either test or execute migration of utPLSQL v2 packages.
73+
74+
## Testing migration
75+
76+
### Dry run migration all utPLSQL v2 packages
77+
Call:
78+
```sql
79+
set serveroutput on
80+
begin
81+
ut_v2_migration.dry_run_all;
82+
end;
83+
/
84+
```
85+
86+
This will execute a dry-run of migration for all utPLSQL v2 packages in the database, that use has access to.
87+
88+
### Dry run migration utPLSQL v2 packages for a user
89+
Call:
90+
```sql
91+
set serveroutput on
92+
begin
93+
ut_v2_migration.dry_run(a_owner => 'XYZ');
94+
end;
95+
/
96+
```
97+
98+
This will execute a dry-run of migration for all utPLSQL v2 packages owned by user `XYZ`.
99+
100+
### Dry run migration utPLSQL v2 suite
101+
Call:
102+
```sql
103+
set serveroutput on
104+
begin
105+
ut_v2_migration.dry_run_for_suite(a_suite_name => 'XYZ');
106+
end;
107+
/
108+
```
109+
110+
This will execute a dry-run of migration for all utPLSQL v2 packages that belong to suite `XYZ`.
111+
112+
### Dry run migration single utPLSQL v2 packages
113+
Call:
114+
```sql
115+
set serveroutput on
116+
begin
117+
ut_v2_migration.dry_run(a_owner => 'XYZ', a_package => 'ABC');
118+
end;
119+
/
120+
```
121+
122+
This will execute a dry-run of migration for utPLSQL v2 package `XYZ.ABC`.
123+
68124
## Executing migration
69125

126+
### Migrate all utPLSQL v2 packages
127+
Call:
128+
```sql
129+
set serveroutput on
130+
begin
131+
ut_v2_migration.run_all;
132+
end;
133+
/
134+
```
135+
136+
This will execute migration for all utPLSQL v2 packages in the database, that use has access to.
137+
138+
### Migrate utPLSQL v2 packages for a user
139+
Call:
140+
```sql
141+
set serveroutput on
142+
begin
143+
ut_v2_migration.run(a_owner => 'XYZ');
144+
end;
145+
/
146+
```
147+
148+
This will execute migration for all utPLSQL v2 packages owned by user `XYZ`.
149+
150+
### Migrate utPLSQL v2 suite
151+
Call:
152+
```sql
153+
set serveroutput on
154+
begin
155+
ut_v2_migration.run_for_suite(a_suite_name => 'XYZ');
156+
end;
157+
/
158+
```
159+
160+
This will execute migration for all utPLSQL v2 packages that belong to suite `XYZ`.
161+
162+
### Migrate single utPLSQL v2 packages
163+
Call:
164+
```sql
165+
set serveroutput on
166+
begin
167+
ut_v2_migration.run(a_owner => 'XYZ', a_package => 'ABC');
168+
end;
169+
/
170+
```
70171

172+
This will execute migration for utPLSQL v2 package `XYZ.ABC`.
71173

0 commit comments

Comments
 (0)