Skip to content

User/tpellissier/use logicalname#19

Merged
tpellissier-msft merged 5 commits intomainfrom
user/tpellissier/use_logicalname
Oct 17, 2025
Merged

User/tpellissier/use logicalname#19
tpellissier-msft merged 5 commits intomainfrom
user/tpellissier/use_logicalname

Conversation

@tpellissier-msft
Copy link
Copy Markdown
Contributor

Copilot summary:

This pull request updates the implementation, documentation and example scripts to consistently use the singular logical name (e.g., "account") instead of the plural entity set name (e.g., "accounts") for all Dataverse SDK method calls. This change improves clarity and aligns with the SDK's preferred usage, reducing confusion for developers and users.

Documentation and usage updates:

  • Updated the README.md to use logical_name (singular) instead of entity_set (plural) for all CRUD, bulk, and file upload method signatures and examples. This includes changes in method descriptions, parameter lists, and code samples. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]
  • Clarified table-related method signatures and behaviors, specifying when friendly names and schema names are used or converted. [1] [2] [3]
  • Updated Pandas helper documentation to emphasize usage of logical names and clarified example references.
  • Removed outdated notes about entity naming conventions for bulk operations, reflecting the new standardization.

Example scripts refactor:

  • Refactored examples/quickstart.py and examples/quickstart_file_upload.py to use the singular logical name variable (logical) for all client method calls (create, get, update, delete, get_multiple, upload_file). This ensures consistency with the updated documentation and SDK interface. [1] [2] [3] [4] [5] [6] [7] [8]

These changes make the SDK easier to use and understand, especially for new users, by enforcing a clear and consistent naming convention throughout the documentation and code examples.

@tpellissier-msft tpellissier-msft force-pushed the user/tpellissier/use_logicalname branch from 42c2dd2 to b1d98ea Compare October 17, 2025 03:49
Comment thread README.md Outdated
Comment thread README.md
Comment thread examples/quickstart.py
@tpellissier-msft tpellissier-msft force-pushed the user/tpellissier/use_logicalname branch from b1d98ea to e062783 Compare October 17, 2025 21:35
Comment thread src/dataverse_sdk/odata.py
@tpellissier-msft tpellissier-msft merged commit e772134 into main Oct 17, 2025
3 checks passed
@zhaodongwang-msft zhaodongwang-msft deleted the user/tpellissier/use_logicalname branch February 13, 2026 21:52
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.

3 participants