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

Try to detect file format automatically during schema inference if it's unknown #59092

Merged
merged 19 commits into from
Feb 16, 2024

Conversation

Avogar
Copy link
Member

@Avogar Avogar commented Jan 22, 2024

Changelog category (leave one):

  • New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Try to detect file format automatically during schema inference if it's unknown in file/s3/hdfs/url/azureBlobStorage engines.
Closes #50576.

Documentation entry for user-facing changes

Examples:

:) select * from format('{"a" : 42, "b" : "Data1"}, {"a" : 43, "b" : "Data2" }')

┌──a─┬─b─────┐
│ 42 │ Data1 │
│ 43 │ Data2 │
└────┴───────┘

:) select * from format('42,"Data1"\n43,"Data2"')

┌─c1─┬─c2────┐
│ 42 │ Data1 │
│ 43 │ Data2 │
└────┴───────┘

:) select * from format('42\tData1\n43\tData2')

┌─c1─┬─c2────┐
│ 42 │ Data1 │
│ 43 │ Data2 │
└────┴───────┘

:) select * from format('(42, ''Data1''), (43, ''Data2'')')

┌─c1─┬─c2────┐
│ 42 │ Data1 │
│ 43 │ Data2 │
└────┴───────┘
  • Documentation is written (mandatory for new features)

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/

@robot-clickhouse robot-clickhouse added the pr-feature Pull request with new product feature label Jan 22, 2024
@robot-clickhouse
Copy link
Member

robot-clickhouse commented Jan 22, 2024

This is an automated comment for commit 2c34a98 with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts✅ success
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS❌ failure
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help❌ failure
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR⏳ pending

@Avogar Avogar marked this pull request as draft January 23, 2024 07:36
@Avogar Avogar marked this pull request as ready for review January 30, 2024 19:41
@serxa serxa self-assigned this Jan 30, 2024
Copy link
Member

@serxa serxa left a comment

Choose a reason for hiding this comment

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

Few small remarks

docs/en/interfaces/schema-inference.md Outdated Show resolved Hide resolved
docs/en/interfaces/schema-inference.md Outdated Show resolved Hide resolved
docs/en/interfaces/schema-inference.md Outdated Show resolved Hide resolved
src/Formats/FormatFactory.cpp Show resolved Hide resolved
src/Formats/ReadSchemaUtils.cpp Outdated Show resolved Hide resolved
{
size_t rows_read = schema_reader->getNumRowsRead();
assert(rows_read <= max_rows_to_read);
max_rows_to_read -= schema_reader->getNumRowsRead();
Copy link
Member

Choose a reason for hiding this comment

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

Minor. Is it better?

A question. rows_read can only increase. Is this correct if we pass here twice for the same file? Or this should never happen?

Suggested change
max_rows_to_read -= schema_reader->getNumRowsRead();
max_rows_to_read -= rows_read;

}

/// We choose the format with larger number of columns in inferred schema.
Copy link
Member

Choose a reason for hiding this comment

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

It is really what we want? Consider a tab-separated file with some textual sentences that may contain commas. There might be a sentence with a lot of commas. This will correspond to a greater number of columns, which IMO is not the "best" fit. Are schema readers smart enough to figure this out under the hood?

Copy link
Member Author

Choose a reason for hiding this comment

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

Are schema readers smart enough to figure this out under the hood?

I would say yes. In your example we will be able to infer the schema from such TSV file only if all first 25k rows will have the same number of commas (so we will have the same number of columns in each row for CSV format, otherwise CSV schema reader won't extract the schema), and this is unlikely to happpen.

/// if we failed to detect the format, we failed to detect the schema of this file
/// in any format. It doesn't make sense to continue.
if (!format_name)
throw Exception(ErrorCodes::CANNOT_DETECT_FORMAT, "The data format cannot be detected by the contents of the files. You can specify the format manually");
Copy link
Member

Choose a reason for hiding this comment

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

Can we specify the exact file name that caused the failure?

Copy link
Member Author

@Avogar Avogar Feb 14, 2024

Choose a reason for hiding this comment

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

src/Formats/ReadSchemaUtils.cpp Show resolved Hide resolved
storage_metadata.setColumns(columns);
}
else
{
if (configuration.format == "auto")
configuration.format = StorageS3::getTableStructureAndFormatFromData(configuration, format_settings, context_).second;
Copy link
Member

Choose a reason for hiding this comment

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

Is it okay that we still need to do all the parsing even if columns are explicitly specified?

Copy link
Member Author

Choose a reason for hiding this comment

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

But we still don't know the format, so we will anyway need to do some parsing.
Yes, with known structure we can do something better, for example try to use format readers instead of schema inference as we know the structure, and it will find the best format for sure. But I considered this use case with unknown format and known structure as really rare to be used by users and didn't want to implement separate logic for it

Avogar and others added 4 commits February 13, 2024 19:08
@Avogar Avogar merged commit 4d6f167 into ClickHouse:master Feb 16, 2024
280 of 284 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-feature Pull request with new product feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Format autodetection by trying several formats in a sequence.
3 participants