{"id":867,"date":"2015-06-22T14:53:50","date_gmt":"2015-06-22T12:53:50","guid":{"rendered":"http:\/\/sematext.solr.pl\/?p=867"},"modified":"2020-11-14T14:54:18","modified_gmt":"2020-11-14T13:54:18","slug":"solr-5-2-quick-look-on-solr-backup-functionality","status":"publish","type":"post","link":"https:\/\/solr.pl\/en\/2015\/06\/22\/solr-5-2-quick-look-on-solr-backup-functionality\/","title":{"rendered":"Solr 5.2: quick look on Solr backup functionality"},"content":{"rendered":"

With the lastest release of Solr – the 5.2<\/a> and 5.2.1<\/a> we were given the new API – the backup API based on the replication handler. Because this functionality has been anticipated by some users, we decided to give it a quick look.<\/p>\n\n\n\n\n\n

In order to test the new functionality we will do a very simple test:<\/p>\n

    \n
  1. We will launch Solr in the SolrCloud mode,<\/li>\n
  2. We will index a few documents,<\/li>\n
  3. We will make the backup using the new API,<\/li>\n
  4. We will index another few documents,<\/li>\n
  5. Finally we will try to restore the backup done in step 3<\/li>\n<\/ol>\n

    Let’s start.<\/p>\n

    Starting Solr<\/h3>\n

    To start Solr in SolrCloud mode, we’ve used the bin\/solr<\/em> script and we’ve used the following command:\n<\/p>\n

    bin\/solr -e cloud\n<\/pre>\n
    For the purpose of the tests we need a single SolrCloud instance, with a single, empty collection (we will use the gettingstarted<\/em> one provided with Solr) and a single shard.<\/p>\n
    Our cluster topology looked as follows:<\/p>\n
    \"Zrzut<\/a><\/p>\n
    Data indexation<\/h3>\n
    Indexing data is as simple as starting Solr. Because we are using the example gettingstarted<\/em> collection we can send documents without defined structure and Solr will adjust the schema.xml<\/em> to what we need. So, for the purpose of the tests we will index two documents using the following command:\n<\/p>\n
    curl 'localhost:8983\/solr\/gettingstarted\/update?commit=true' -H 'Content-type:application\/xml' --data-binary '\n<add>\n <doc>\n  <field name=\"id\">1<\/field>\n  <field name=\"name\">Test document 1<\/field>\n <\/doc>\n <doc>\n  <field name=\"id\">2<\/field>\n  <field name=\"name\">Test document 2<\/field>\n <\/doc>\n<\/add>'\n<\/pre>\n
    Backup<\/h3>\n
    Making a backup is again very simple. We just need to run the following command:\n<\/p>\n
    curl 'http:\/\/localhost:8983\/solr\/gettingstarted\/replication?command=backup&name=test&location=\/Users\/gro\/backup\/'\n<\/pre>\n
    The above command tells Solr, that we want to make a backup of our collection called snapshot.test<\/em> (Solr will add the value of the name<\/em> parameter to the snapshot.<\/em> prefix). The backup itself, will be created in the collection data directory by default – this is when we will not provide the desired directory using the location<\/em> parameter. In our example, we’ve provided that parameter and use an absolute path to tell Solr where the backup should be placed.<\/p>\n
    The response from Solr should be fast and look similar to the following one:\n<\/p>\n
    <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n <lst name=\"responseHeader\"><int name=\"status\">0<\/int><int name=\"QTime\">2<\/int><\/lst><str name=\"status\">OK<\/str>\n<\/response>\n<\/pre>\n
    Of course, if our collection is large, the time needed to create backup will be significantly larger. We can check the status our the backup creation by running the following command:\n<\/p>\n
    curl 'http:\/\/localhost:8983\/solr\/gettingstarted\/replication?command=details'\n<\/pre>\n
    Next indexation<\/h3>\n
    The next step of our simple test is another indexation – this time adding two new documents using the following command:\n<\/p>\n
    curl 'localhost:8983\/solr\/gettingstarted\/update?commit=true' -H 'Content-type:application\/xml' --data-binary '\n<add>\n <doc>\n  <field name=\"id\">3<\/field>\n  <field name=\"name\">Test document 3<\/field>\n <\/doc>\n <doc>\n  <field name=\"id\">4<\/field>\n  <field name=\"name\">Test document 4<\/field>\n <\/doc>\n<\/add>'\n<\/pre>\n
    After the above command, if we would run a simple query like the following one:\n<\/p>\n
    curl 'localhost:8983\/solr\/gettingstarted\/select?q=*:*&rows=0&indent=true'\n<\/pre>\n
    Solr should respond and inform us that we have four documents in total:\n<\/p>\n
    <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n <lst name=\"responseHeader\">\n  <int name=\"status\">0<\/int>\n  <int name=\"QTime\">6<\/int>\n  <lst name=\"params\">\n   <str name=\"q\">*:*<\/str>\n   <str name=\"indent\">true<\/str>\n   <str name=\"rows\">0<\/str>\n  <\/lst>\n <\/lst>\n <result name=\"response\" numFound=\"4\" start=\"0\" maxScore=\"1.0\">\n <\/result>\n<\/response>\n<\/pre>\n
    Restoring our backup<\/h3>\n
    Now let’s try restoring our backup and see how many documents we will have after that operation. To restore the bacup we’ve created we run the following command:\n<\/p>\n
    curl 'http:\/\/localhost:8983\/solr\/gettingstarted\/replication?command=restore&name=test&location=\/Users\/gro\/backup\/'\n<\/pre>\n
    If everything went well, Solr response should be similar to the following one:\n<\/p>\n
    <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n <lst name=\"responseHeader\"><int name=\"status\">0<\/int><int name=\"QTime\">2<\/int><\/lst><str name=\"status\">OK<\/str>\n<\/response>\n<\/pre>\n
    So let’s now check how many documents are present in our collection by running the following command:\n<\/p>\n
    curl 'localhost:8983\/solr\/gettingstarted\/select?q=*:*&rows=0&indent=true'\n<\/pre>\n
    <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n <lst name=\"responseHeader\">\n  <int name=\"status\">0<\/int>\n  <int name=\"QTime\">0<\/int>\n  <lst name=\"params\">\n   <str name=\"q\">*:*<\/str>\n   <str name=\"indent\">true<\/str>\n   <str name=\"rows\">0<\/str>\n  <\/lst>\n <\/lst>\n <result name=\"response\" numFound=\"2\" start=\"0\">\n <\/result>\n<\/response>\n<\/pre>\n
    As we can see, the number of documents in the collection is 2, which mean that our backup has been properly restored.<\/p>\n
    Short summary<\/h3>\n
    As we can see, Solr backup mechanism works flawlessly, however we should remember about few things. When running a few Solr instances on the same physical machine, we should avoid doing backups using absolute paths – we can end up with shards data being overwritten. Apart from that, its good to finally have fully working and easy to use backup functionality \ud83d\ude42<\/p>","protected":false},"excerpt":{"rendered":"
    With the lastest release of Solr – the 5.2 and 5.2.1 we were given the new API – the backup API based on the replication handler. Because this functionality has been anticipated by some users, we decided to give it<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_links_to":"","_links_to_target":""},"categories":[27],"tags":[590,488,164],"class_list":["post-867","post","type-post","status-publish","format-standard","hentry","category-solr-en","tag-5-2-2","tag-backup-2","tag-solr-2"],"_links":{"self":[{"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/posts\/867","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/comments?post=867"}],"version-history":[{"count":1,"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/posts\/867\/revisions"}],"predecessor-version":[{"id":868,"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/posts\/867\/revisions\/868"}],"wp:attachment":[{"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/media?parent=867"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/categories?post=867"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/solr.pl\/en\/wp-json\/wp\/v2\/tags?post=867"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}