Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add edit log managment command #414

Merged
merged 3 commits into from
May 6, 2024
Merged

Conversation

johnatawnclementawn
Copy link
Member

brief description of changes

Accounts for a new management command added in archesproject/arches#10837

issues addressed

further comments


This box must be checked

  • the PR branch was originally made from the base branch

This box should be checked

  • after these changes the docs build locally without error

This box should only be checked you intend to follow through on it (we can do it on our end too)

  • I will cherry-pick all commits in this PR into other branches that should have them after this PR is merged

@johnatawnclementawn johnatawnclementawn marked this pull request as ready for review May 2, 2024 14:07
@johnatawnclementawn
Copy link
Member Author

Featured merged in 10837, @ekansa - this is ready for review

Copy link
Collaborator

@ekansa ekansa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll go ahead and approve this. I will want to add some cross-references to it from other parts of the documentation. I think we need to have much more documentation on data management / data lifecycle good practices with Arches too.

@@ -308,6 +320,8 @@ models, branches, thesauri, and collections intact.

This mimics the 'Create Mapping File' command from the Arches Designer UI.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a link to the part of the documentation describing mapping files:


:ref:`Mapping File`

@@ -308,6 +320,8 @@ models, branches, thesauri, and collections intact.

This mimics the 'Create Mapping File' command from the Arches Designer UI.

import mapping file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to give a little more description about when and why one may want to import a mapping file? Just a sentence or two about what role mapping files play in ETL workflows and when these command line utilities will be of use.


python manage.py resources clear_edit_log

Removes all entries from the Arches Edit Log.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to know when / why it may be a good idea to purge the edit log.

@@ -299,6 +301,16 @@ Other Data Management Commands
Removes all resources from your database, but leaves the all resources
models, branches, thesauri, and collections intact.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems drastic! Does this command leave a trace in the edit log? We may want to give a warning that this nukes a big chuck of your database...

@ekansa ekansa merged commit 546e61b into master May 6, 2024
@ekansa ekansa deleted the master_add_edit_log_mgmt_command branch May 6, 2024 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants