| Name | db-queries-bulk-migrator JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-10-23 20:13:08 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Dynatrace DB Queries Extension Bulk Migrator
Tool to help with creating Extensions 2.0 declarative SQL extensions off of Extensions 1.0 Custom DB Queries extension configurations.
## API Authentication
For commands that interact with the Dynatrace API you need to provide an API URL and Access token. These can be provided on the command line but it is recommended to use environment variables:
- DT_URL (e.g. https://xxx.live.dynatrace.com)
- DT_TOKEN
- permissions:
- ReadConfig
- WriteConfig
- extensions.read
- extensions.write
- metrics.read
## Commands
Use `--help` with any command to view unique options.
```
Usage: dbqm pull [OPTIONS]
Pull EF1 db queries configurations into a spreadsheet.
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * --dt-url TEXT [env var: DT_URL] [default: None] [required] │
│ * --dt-token TEXT [env var: DT_TOKEN] [default: None] [required] │
│ --output-file TEXT [default: custom.remote.python.dbquery-export.xlsx] │
│ --help Show this message and exit.
```
### dbqm pull
Used to pull all EF1 Custom DB Queries configurations and export them to an Excel sheet for manual review and as an input to later steps.
### dbqm build
Used to build extensions from a previously exported configuration excel workbook.
#### Certificate and key
Before building you need to create a developer key and certificate. These will be used to sign the extension packages. Refer to the steps [here](https://docs.dynatrace.com/docs/shortlink/sign-extension#cert) for creating the certificate and key file(s). The `developer.pem` file will be used in the build command.
#### Required options
- `--cert-file-path` path to developer.pem
- `--private-key-path` path to developer.pem
- `--input-file` path to the previously exported configuration exce;
- `--merge-endpoints` tells the tool to merge endpoints based on a matching host or jdbc string (to avoid hitting limits if it were one extension per EF1 DB queries endpoint)
- `--directory` path to where the migrated extensions will be stored locally
Example:
```
dbqm build --cert-file-path=developer.pem --private-key-path=developer.pem --input-file=custom.remote.python.dbquery-export.xlsx --merge-endpoints --directory=C:\workspaces\migrated_extensions
```
After running in the directory (default: migrated_extensions) you will see a directory per new extension which will contain a src directory and a signed zip of the new extension.
Raw data
{
"_id": null,
"home_page": null,
"name": "db-queries-bulk-migrator",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/87/7c/b147545b468c6e4d70f85286e2f4f40a833303cf3b397687866427dd294b/db_queries_bulk_migrator-0.2.0.tar.gz",
"platform": null,
"description": "# Dynatrace DB Queries Extension Bulk Migrator\n\nTool to help with creating Extensions 2.0 declarative SQL extensions off of Extensions 1.0 Custom DB Queries extension configurations.\n\n## API Authentication\n\nFor commands that interact with the Dynatrace API you need to provide an API URL and Access token. These can be provided on the command line but it is recommended to use environment variables:\n\n- DT_URL (e.g. https://xxx.live.dynatrace.com)\n- DT_TOKEN\n - permissions:\n - ReadConfig\n - WriteConfig\n - extensions.read\n - extensions.write\n - metrics.read\n\n## Commands\n\nUse `--help` with any command to view unique options.\n\n```\n Usage: dbqm pull [OPTIONS]\n\n Pull EF1 db queries configurations into a spreadsheet.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --dt-url TEXT [env var: DT_URL] [default: None] [required] \u2502\n\u2502 * --dt-token TEXT [env var: DT_TOKEN] [default: None] [required] \u2502\n\u2502 --output-file TEXT [default: custom.remote.python.dbquery-export.xlsx] \u2502\n\u2502 --help Show this message and exit. \n```\n\n### dbqm pull\n\nUsed to pull all EF1 Custom DB Queries configurations and export them to an Excel sheet for manual review and as an input to later steps.\n\n### dbqm build\n\nUsed to build extensions from a previously exported configuration excel workbook.\n\n#### Certificate and key\n\nBefore building you need to create a developer key and certificate. These will be used to sign the extension packages. Refer to the steps [here](https://docs.dynatrace.com/docs/shortlink/sign-extension#cert) for creating the certificate and key file(s). The `developer.pem` file will be used in the build command.\n\n#### Required options\n\n- `--cert-file-path` path to developer.pem\n- `--private-key-path` path to developer.pem\n- `--input-file` path to the previously exported configuration exce;\n- `--merge-endpoints` tells the tool to merge endpoints based on a matching host or jdbc string (to avoid hitting limits if it were one extension per EF1 DB queries endpoint)\n- `--directory` path to where the migrated extensions will be stored locally\n\nExample:\n\n```\ndbqm build --cert-file-path=developer.pem --private-key-path=developer.pem --input-file=custom.remote.python.dbquery-export.xlsx --merge-endpoints --directory=C:\\workspaces\\migrated_extensions\n```\n\nAfter running in the directory (default: migrated_extensions) you will see a directory per new extension which will contain a src directory and a signed zip of the new extension.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8a07d95a48911177c5cab6c13b54aea3485e4978642bd88d19cc95693abd05b4",
"md5": "a26e8532be3bbf1d6574489f59483e14",
"sha256": "2f1b696d0f95e565cd7e69cf6a9ec62e34885eec0c23597d56c68ada6b26d6c3"
},
"downloads": -1,
"filename": "db_queries_bulk_migrator-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a26e8532be3bbf1d6574489f59483e14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 8571,
"upload_time": "2024-10-23T20:13:06",
"upload_time_iso_8601": "2024-10-23T20:13:06.352724Z",
"url": "https://files.pythonhosted.org/packages/8a/07/d95a48911177c5cab6c13b54aea3485e4978642bd88d19cc95693abd05b4/db_queries_bulk_migrator-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "877cb147545b468c6e4d70f85286e2f4f40a833303cf3b397687866427dd294b",
"md5": "51b5d9bf6f967963e13aac48a7efc08b",
"sha256": "6feb5c9a689f056032a053011d592ae6f315112e3ad70caf73c6782fb6b1bd1a"
},
"downloads": -1,
"filename": "db_queries_bulk_migrator-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "51b5d9bf6f967963e13aac48a7efc08b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 6812,
"upload_time": "2024-10-23T20:13:08",
"upload_time_iso_8601": "2024-10-23T20:13:08.139183Z",
"url": "https://files.pythonhosted.org/packages/87/7c/b147545b468c6e4d70f85286e2f4f40a833303cf3b397687866427dd294b/db_queries_bulk_migrator-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 20:13:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "db-queries-bulk-migrator"
}
