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

docs: Update readme to reflect tracing feature is needed for read-table #619

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

OussamaSaoudi-db
Copy link
Collaborator

What changes are proposed in this pull request?

Updates the docs to reflect that tracing is required to be enabled in the read_table.c example code.

How was this change tested?

Compiling without the tracing feature yields the following error:

Undefined symbols for architecture arm64:
  "_enable_event_tracing", referenced from:
      _main in read_table.c.o

And compiling with it works.

@OussamaSaoudi-db
Copy link
Collaborator Author

The error comes from this line in read_table.c.

@OussamaSaoudi-db OussamaSaoudi-db marked this pull request as ready for review January 3, 2025 23:20
Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.45%. Comparing base (ba37b62) to head (4ca2f36).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #619      +/-   ##
==========================================
+ Coverage   83.43%   83.45%   +0.01%     
==========================================
  Files          75       75              
  Lines       16922    16922              
  Branches    16922    16922              
==========================================
+ Hits        14119    14122       +3     
  Misses       2146     2146              
+ Partials      657      654       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@nicklan nicklan left a comment

Choose a reason for hiding this comment

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

ugg this is a bit of a mess. thanks for noticing this. So, default-engine is a "default" feature in the ffi crate. So you'd have to do --no-default-features to not get it, and then read-table would break.

So probably just update the docs to specify that you should enable the tracing feature and remove any mention of the default-engine one for now.

@zachschuermann, let's add this to the list of things we need to fix when we look at feature flags again.

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