-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Updated README.md to contain a more friendly version. #5374
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
base: 10.11
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,99 @@ | ||
| # Code status: | ||
|
|
||
| * [](https://ci.appveyor.com/project/rasmushoj/server) ci.appveyor.com | ||
|
|
||
| ## MariaDB: The innovative open source database | ||
|
|
||
| MariaDB was designed as a drop-in replacement of MySQL(R) with more | ||
| features, new storage engines, fewer bugs, and better performance. | ||
|
|
||
| MariaDB is brought to you by the MariaDB Foundation and the MariaDB Corporation. | ||
| Please read the CREDITS file for details about the MariaDB Foundation, | ||
| and who is developing MariaDB. | ||
|
|
||
| MariaDB is developed by many of the original developers of MySQL who | ||
| now work for the MariaDB Corporation, the MariaDB Foundation and by | ||
| many people in the community. | ||
|
|
||
| MySQL, which is the base of MariaDB, is a product and trademark of Oracle | ||
| Corporation, Inc. For a list of developers and other contributors, | ||
| see the Credits appendix. You can also run 'SHOW authors' to get a | ||
| list of active contributors. | ||
|
|
||
| A description of the MariaDB project and a manual can be found at: | ||
|
|
||
| https://mariadb.org | ||
|
|
||
| https://mariadb.com/docs/ | ||
|
|
||
| https://mariadb.com/docs/release-notes/community-server/about/compatibility-and-differences/mariadb-vs-mysql-features | ||
|
|
||
| https://mariadb.com/docs/release-notes/community-server/about/compatibility-and-differences/mariadb-vs-mysql-compatibility | ||
|
|
||
| https://mariadb.com/docs/release-notes | ||
|
|
||
| # Getting the code, building it and testing it | ||
|
|
||
| Refer to the following guide: https://mariadb.org/get-involved/getting-started-for-developers/get-code-build-test/ | ||
| which outlines how to build the source code correctly and run the MariaDB testing framework, | ||
| as well as which branch to target for your contributions. | ||
|
|
||
| # Help | ||
|
|
||
| More help is available from the Maria Discuss mailing list | ||
| https://lists.mariadb.org/postorius/lists/discuss.lists.mariadb.org/ and MariaDB's Zulip | ||
| instance, https://mariadb.zulipchat.com/ | ||
|
|
||
| # Licensing | ||
|
|
||
| *************************************************************************** | ||
|
|
||
| MariaDB is specifically available only under version 2 of the GNU | ||
| General Public License (GPLv2). (I.e. Without the "any later version" | ||
| clause.) This is inherited from MySQL. Please see the README file in | ||
| the MySQL distribution for more information. | ||
|
|
||
| License information can be found in the COPYING file. Third party | ||
| license information can be found in the THIRDPARTY file. | ||
|
|
||
| *************************************************************************** | ||
|
|
||
| # Bug Reports | ||
|
|
||
| Bug and/or error reports regarding MariaDB should be submitted at: | ||
| https://jira.mariadb.org | ||
|
|
||
| For reporting security vulnerabilities see: | ||
| https://mariadb.org/about/security-policy/ | ||
|
|
||
| The code for MariaDB, including all revision history, can be found at: | ||
| https://github.com/MariaDB/server | ||
| # MariaDB Server | ||
|
|
||
| MariaDB Server is one of the most widely deployed open source relational | ||
| databases. It is built by a global community of contributors together with | ||
| the MariaDB Foundation and MariaDB plc, and it powers workloads from small | ||
| applications to large-scale production systems. | ||
|
|
||
| MariaDB began as a fork of MySQL, led by the original MySQL developers, | ||
| and it maintains a high degree of MySQL compatibility. It has since grown | ||
| into a database with its own capabilities, including native vector search, | ||
| multiple pluggable storage engines, synchronous clustering, and analytical | ||
| features, while remaining a straightforward migration target for existing | ||
| MySQL deployments. | ||
|
|
||
| ## Key features | ||
|
|
||
| * **Native vector search**. A built-in VECTOR data type with approximate | ||
| nearest-neighbour indexing (HNSW), available since MariaDB 11.8 with | ||
| no extension required. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no vector search in 10.11 |
||
| * **Pluggable storage engines**. InnoDB (default for transactional workloads), | ||
| Aria, MyRocks, ColumnStore for analytics, Spider for sharding, and S3 | ||
| for archival, among others. | ||
| * **Replication and clustering**. Asynchronous, semi-synchronous, and | ||
| parallel replication with global transaction IDs, plus Galera synchronous | ||
| multi-primary clustering. | ||
| * **Advanced SQL**. Common table expressions and recursive CTEs, window | ||
| functions, system-versioned (temporal) tables, sequences, and a broad set | ||
| of JSON functions. | ||
| * **MySQL and Oracle compatibility**. Wire-protocol and syntax compatibility | ||
| with MySQL, plus an Oracle SQL mode supporting PL/SQL-style stored routines. | ||
| * **Spatial and full-text search**. GIS data types and functions, and built-in | ||
| full-text indexing. | ||
| * **Security**. Role-based access control, pluggable authentication (ed25519, | ||
| PAM, GSSAPI, and more), data-at-rest encryption, and TLS for connections. | ||
|
|
||
| ## Documentation | ||
|
|
||
| * [Project home, community, and getting involved](https://mariadb.org) | ||
| * [Reference manual and release notes](https://mariadb.com/docs/) | ||
| * [MariaDB compared to MySQL](https://mariadb.com/docs/release-notes/community-server/about/compatibility-and-differences/mariadb-vs-mysql-features) | ||
|
|
||
| ## Releases | ||
|
|
||
| MariaDB Server follows a yearly long-term support (LTS) model alongside | ||
| quarterly rolling releases. LTS releases are maintained for three years and | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Binary LTS releases are ..." |
||
| are recommended for production; rolling releases deliver new features sooner | ||
| with a shorter support window. | ||
|
|
||
| For the current version and full history, see | ||
| [Releases](https://github.com/MariaDB/server/releases) and | ||
| the [MariaDB release calendar](https://mariadb.org/mariadb/all-releases/). | ||
|
|
||
| ## Installing | ||
|
|
||
| Packages and installation instructions for all supported platforms are | ||
| available at [https://mariadb.org/download/](https://mariadb.org/download/). | ||
|
|
||
| ## Building from source | ||
|
|
||
| To build MariaDB from source and run the test suite, follow the | ||
| [developer guide](https://mariadb.org/get-involved/getting-started-for-developers/get-code-build-test/) | ||
|
|
||
| It covers building the code correctly, running the MariaDB testing framework, | ||
| and choosing the right branch to target for contributions. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are welcome, from code and documentation to bug reports and | ||
| reviews. See [CONTRIBUTING.md](CONTRIBUTING.md) to | ||
| get started, and [CODING_STANDARDS.md](CODING_STANDARDS.md) | ||
| for code style. Contributors and community members are recognised in | ||
| [CREDITS](CREDITS); you can also run `SHOW authors` in | ||
| a running server for the list of active contributors. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Active? It mentions Konstantin Osipov and Mikael Ronström. Let's not talk about {{SHOW AUTHORS}} in README |
||
|
|
||
| ## Getting help | ||
|
|
||
| * [Zulip chat](https://mariadb.zulipchat.com/) | ||
| * [Maria Discuss mailing list](https://lists.mariadb.org/postorius/lists/discuss.lists.mariadb.org/) | ||
| * [Bug reports](https://jira.mariadb.org) | ||
| * Security vulnerabilities: see [SECURITY.md](SECURITY.md) | ||
| and [https://mariadb.org/about/security-policy/](https://mariadb.org/about/security-policy/) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Mention either SECURITY.md or https://mariadb.org/about/security-policy. Not both. |
||
|
|
||
| ## Licensing | ||
|
|
||
| MariaDB Server is licensed under version 2 of the GNU General Public | ||
| License (GPLv2), without the "any later version" clause. This is inherited from | ||
| MySQL. License information is in the [COPYING](COPYING) | ||
| file, and third-party license information is in the | ||
| [THIRDPARTY](THIRDPARTY) file. | ||
|
|
||
| ## About | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ? |
||
|
|
||
| MariaDB is brought to you by the MariaDB Foundation and MariaDB plc. | ||
| The MariaDB Foundation is the custodian of the MariaDB Server codebase, | ||
| ensuring it stays open and that anyone can contribute. | ||
| See [CREDITS](CREDITS) for details on the Foundation | ||
| and the people developing MariaDB. | ||
|
|
||
| MySQL, the base of MariaDB, is a product and trademark of Oracle Corporation, Inc. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you sure you want to start with a history?