diff --git a/docs/ref-database-util.md b/docs/ref-database-util.md new file mode 100644 index 000000000..34abe2321 --- /dev/null +++ b/docs/ref-database-util.md @@ -0,0 +1,188 @@ +--- +title: Database util +category: reference +order: 99 +--- + +`Database util` is a tool for managing database entries created by abapGit. You can access the tool via the tools icon in the top right corner of the abapGit home page > choose first menu item `Database util`. + +It's possible to edit database entries of type + +- `USER` and +- `REPO`. + +A `USER` entry contains meta information like the favorites of an user and their repository configurations e. g. name and email address for Git. This is an example of a `USER` entry: + +```xml + + + + + + + + + + + + + + + 000000000001 + 000000000002 + 000000000003 + + + + https://[...]/file.git + my_username + + First and Last Name + email@example.com + + + + + https://[...]/file.git + my_second_user + + First and Last Name + email@example.com + + + + + + 0 + + + + + + + + + + + + + +``` + +The `REPO` entries contain meta data like Git repository URL, branch and package information and information about files known and to be excluded. This is an example: + +```xml + + + + + https://[...]/file.git + refs/heads/my_branch + Z_MY_PACKAGE + my_user + 20200418201549.200418 + my_user + 20200507134505.184445 + + + + + + + + + + + + / + .abapgit.xml + [...] + + + + + + DEVC + Z_MY_PACKAGE + Z_MY_PACKAGE + + + + + /src/ + package.devc.xml + [...] + + + + + + DEVC + Z_ANOTHER_PACKAGE + Z_ANOTHER_PACKAGE + + + + + /src/abaplinted_sample/ + package.devc.xml + [...] + + + + + + PROG + Z_MY_REPORT + Z_ANOTHER_PACKAGE + + + + + /src/abaplinted_sample/ + z_my_report.prog.abap + [...] + + + /src/abaplinted_sample/ + z_my_report.prog.xml + [...] + + + + + + E + /src/ + PREFIX + + /.gitignore + /LICENSE + /README.md + /package.json + /.travis.yml + /.gitlab-ci.yml + /abaplint.json + /azure-pipelines.yml + /src/.gitkeep + + + + + + My Test Repository + + + + ZMY_CHECK_VARIANT + X + + + + + +``` + +If you remove a repository entry from the database util, the repository is not shown in abapGit anymore. This is useful for example if you want to remove a repository which has a non-existing package assigned and thus can't be opened and deleted normally. + +Be careful when you edit these entries from within abapGit. Setting invalid options there might break your abapGit.