Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 46.3Mb
PDF (A4) - 46.3Mb
PDF (RPM) - 41.7Mb
HTML Download (TGZ) - 10.6Mb
HTML Download (Zip) - 10.7Mb
HTML Download (RPM) - 9.2Mb
Man Pages (TGZ) - 224.0Kb
Man Pages (Zip) - 329.4Kb
Info (Gzip) - 4.1Mb
Info (Zip) - 4.1Mb
Excerpts from this Manual Add Documents

Use the add() method to insert one document or a list of documents into an existing collection using MySQL Shell. All examples in this section use the countryinfo collection, which is provided in the world_x schema.

Add a Document

Insert the following document into the countryinfo collection. As this is multi-line content, press Enter twice to insert the document.

mysql-js> db.countryinfo.add(
    GNP: .6,
    IndepYear: 1967,
    Name: "Sealand",
    demographics: {
        LifeExpectancy: 79,
        Population: 27
    geography: {
        Continent: "Europe",
        Region: "British Islands",
        SurfaceArea: 193
    government: {
        GovernmentForm: "Monarchy",
        HeadOfState: "Michael Bates"

The method returns the status of the operation.

Each document requires an identifier field called _id. The value of the _id field must be unique among all documents in the same collection. In MySQL 8.0.11 and higher, document IDs are generated by the server, not the client, so MySQL Shell does not automatically set an _id value. A MySQL server at 8.0.11 or higher sets an _id value if the document does not contain the _id field. A MySQL server at an earlier 8.0 release or at 5.7 does not set an _id value in this situation, so you must specify it explicitly. If you do not, MySQL Shell returns error 5115 Document is missing a required field.

Related Information