Turinio sinchronizavimas
Blockstudio pagrįstas failais grindžiama darbo eiga: blokai, laukai, šablonai, ištekliai, šablonų rinkiniai ir failais pagrįsti puslapiai gali būti saugomi jūsų projekte. Turinio sinchronizavimas išplečia šį modelį ir apima pasirinktą WordPress duomenų bazės turinį, kad komandos galėtų git saugoti ir tvarkomus įrašus, terminus, ryšius bei deklaruotus metaduomenis.
Tai yra WP-CLI darbo eiga, o ne tiesioginis duomenų bazės replikavimas. Sinchronizuojant iš duomenų bazės į failus, į temą perkeliami leistini įrašai, postmeta, terminai, termmeta ir įrašų bei terminų ryšiai. Sinchronizuojant iš failų į duomenų bazę, šie failai pritaikomi kitoje aplinkoje naudojant stabilius UID ir perrašant tik aiškiai deklaruotas nuorodas.
Pastaba
Turinio sinchronizavimas vykdomas pagal poreikį. Jis nevykdomas su kiekviena administravimo užklausa. Kol
content.enablednėratrue, komandos pateikia praleistą eilutę.
Kada naudoti turinio sinchronizavimą
Naudokite turinio sinchronizavimą turinio rinkiniams, kuriuos svarbu versijuoti, peržiūrėti ir perkelti iš vienos aplinkos į kitą:
- struktūruotam turiniui, pavyzdžiui, komandos nariams, vietoms, atvejų analizėms, produktams, dokumentacijos įrašams ar kampanijų puslapiams
- taksonomijoms ir ryšiams, susijusiems su tais turinio rinkiniais
- leistiniems metaduomenims, kuriuos saugu įtraukti į saugyklą ir kuriems reikia stabilių nuorodų
- mažiems ir vidutiniams turinio rinkiniams, kurių failus dar praktiška peržiūrėti git
Paprastai turinio sinchronizavimas patogus dešimtims ar šimtams eilučių; jis gali apdoroti ir kelis tūkstančius, jei duomenys struktūruoti, retai keičiasi ir suskirstyti į atskirus įrašų tipus. Jis nėra skirtas visos gamybinės duomenų bazės, dažnai atnaujinamo redakcinio turinio, žurnalų, užsakymų, analitikos duomenų, formų pateikčių, sesijų ar kitų didelės apimties arba dažnai besikeičiančių duomenų kopijai palaikyti. Jei sugeneruotus failus tampa sunku peržiūrėti dėl perteklinio triukšmo, pakeitimų perkėlimas užtrunka arba dauguma įrašų keičiasi ne pagal diegimo eigą, vietoj to naudokite duomenų bazės atsarginę kopiją, migravimo arba importavimo ir eksportavimo įrankį.
Medijos dvejetainiai failai nekopijuojami. Priedų nuorodas galima įrašyti manifeste ir patikrinti, tačiau patys failai turi būti tikslinėje aplinkoje.
Konfigūracija
Įjunkite turinio sinchronizavimą faile blockstudio.json:
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"content": {
"enabled": true,
"id": "default",
"path": "content",
"includePageSyncManaged": false,
"authors": "ignore",
"postTypes": ["team_member"],
"meta": {
"include": ["_my_*"],
"exclude": ["_edit_lock", "_edit_last", "_wp_old_slug"],
"references": {
"_thumbnail_id": { "kind": "attachment" },
"_related_posts": { "kind": "post", "path": "*" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
},
"taxonomies": [],
"media": "manifest"
}
}
postTypes yra leidžiamų įrašų sąrašas. Jei jis tuščias, turinio sinchronizavimas įrašų nelies. taxonomies yra jau užregistruotų taksonomijų, kurių terminus ir ryšius su įrašais reikia sinchronizuoti, sąrašas. Blockstudio neregistruoja taksonomijų apibrėžimų iš turinio sinchronizavimo failų. Įrašų ir terminų metaduomenų leidžiamų laukų sąrašai nustatomi per meta.include; meta.exclude visada turi pirmenybę.
Įspėjimas
Laikykite
meta.includeįtraukimo į saugyklą riba. Sinchronizuoti failai skirti saugoti git, todėl neįtraukite raktų, kuriuose yra paslapčių, prieigos žetonų, prisijungimo duomenų ar asmens identifikavimo informacijos.wp bs content statuspateikia įspėjimo eilutes, kai leistino sąrašo metaduomenų raktas atrodo jautrus.
content.id saugomas sinchronizuotuose objektuose kaip _blockstudio_content_set. Naikinimo ir nuosavybės patikros apribotos šia reikšme, todėl vienas turinio rinkinys negali ištrinti kito rinkinio turinio.
Pagal numatytuosius nustatymus „Page Sync“ tvarkomi įrašai neįtraukiami. Jei įjungta includePageSyncManaged, turinio sinchronizavimas gali sinchronizuoti jiems sukonfigūruotus metaduomenis, tačiau „Page Sync“ ir toliau valdo jų post_content.
Šiose projekcijose yra "bodyOwner": "page-sync". Pull praneša apie JSON įrašą tik kaip metaduomenis ir prideda skipped turinio eilutę, todėl įrašas nepateikiamas taip, tarsi jo turinys būtų tuščias. Gretimas .html failas nėra įrašomas ar šalinamas. Esama peržiūros kopija išsaugoma ir push jos nepaiso. Tos pačios nuosavybės žinutės įtraukiamos į bandomojo vykdymo išvestį.
Kitoje aplinkoje pirmiausia paleiskite Page Sync. Projekcija su bodyOwner: "page-sync" turi nurodyti esamą Page Sync valdomą įrašą; push atsisako sukurti tuščią pakaitalą arba pritaikyti to įrašo peržiūros kopiją. Senesnių versijų projekcijos be žymeklio tebepalaikomos.
Autoriai pagal numatytuosius nustatymus ignoruojami, nes naudotojai nesinchronizuojami. Nustatykite authors: "login", kad įrašų failuose būtų saugomas autoriaus prisijungimo vardas ir jį sinchronizuojant į kitą aplinką būtų susieta su esamu naudotoju. Jei naudotojo nėra, išankstinė patikra pateikia klaidą; turinio sinchronizavimas naudotojų nesukuria.
Komandos
wp bs content pull [--post-type=<type>] [--taxonomy=<taxonomy>] [--dry-run]
wp bs content push [--dry-run] [--prune] [--yes]
wp bs content status
pull įrašo duomenų bazės turinį į failus. Jis priskiria _blockstudio_content_uid į aprėptį patenkantiems įrašams, kurie jo dar neturi, ir pateikia pasenusius failus, kurių šaltinio duomenų bazėje nebėra. Pasenę failai sinchronizuojant iš duomenų bazės į failus neištrinami.
push pritaiko failus dabartinei duomenų bazei. Prieš ką nors įrašydamas jis patikrina planą ir sustabdo vykdymą, jei yra neišspręstų deklaruotų nuorodų, adresų konfliktų, užrakintų objektų ar trūkstamų įrašų tipų.
status palygina failus su duomenų baze ir kiekvienam objektui pateikia būseną: unchanged, would-update, missing-db, conflict, locked arba orphaned. Jis taip pat įspėja apie leistinų metaduomenų raktus, kurie atrodo kaip paslaptys, prieš įtraukiant tas reikšmes į saugyklą, ir apie skaitinius ID blokų žymėjimo turinyje, nes turinio sinchronizavimas neperrašo ID .html failuose.
Naudokite --dry-run, kad peržiūrėtumėte sinchronizavimą į failus arba iš jų nieko neįrašydami. Naudokite push --prune --yes, kad pašalintumėte duomenų bazės objektus, priklausančius turinio rinkiniui, kurių failuose nebėra.
Apsauga nuo nesėkmių
push išanalizuoja ir patikrina visą šaltinio planą prieš įrašydamas ar
pašalindamas duomenis. Netaisyklingas JSON, neišspręstos deklaruotos nuorodos, negaliojanti nuosavybė ir
kitos išankstinės patikros klaidos sustabdo naikinimo etapą. Šalinimas apribotas
sukonfigūruotais įrašų tipais, taksonomijomis ir content.id.
pull pirmiausia įrašo kiekvieną perkeltą failą, o tik tada pažymi atitinkamą objektą kaip sinchronizuotą. Dėl failų sistemos įrašymo klaidos pateikiama klaidos eilutė, o objekto išsaugota sinchronizavimo būsena neatnaujinama.
Priedų tvarkymas vykdomas pagal content.media. Naudojant "manifest", nurodytų priedų UID turi egzistuoti tikslinėje aplinkoje. Naudojant "none", deklaruotos priedų nuorodos sąmoningai pašalinamos iš perkeliamo išvesties turinio, užuot išsaugojus konkrečiai aplinkai būdingus ID.
Failai
Content Sync įrašo failus į sukonfigūruotą content.path:
content/
posts/
team_member/
jane.9b1c0e6e.json
jane.9b1c0e6e.html
terms/
category/
leadership.5e900000.json
media/
manifest.json
Įrašo .json failuose saugoma tapatybė, įrašo laukai, terminų ryšiai, deklaruoti meta duomenys ir jų koduotė. Gretimame .html faile post_content saugomas kaip neapdorotas blokų žymėjimas; jei turinys tuščias, šis failas neįtraukiamas. Terminų .json failuose saugoma tapatybė, taksonomija, nuoroda, pavadinimas, aprašymas, pirminio elemento UID, deklaruoti termmeta duomenys ir jų koduotė.
Kitas atvejis, kai nėra .html failo, yra Page Sync valdomas turinys, nurodytas aukščiau per bodyOwner. Įprastiems įrašams, kurių turinys tampa tuščias, pull pašalina seną turinio failą ir nurodo jį atskiroje deleted turinio eilutėje.
{
"uid": "9b1c0e6e-0000-4000-9000-000000000000",
"type": "team_member",
"status": "publish",
"slug": "jane",
"title": "Jane",
"parent": null,
"menuOrder": 0,
"terms": {
"category": ["5e900000-0000-4000-9000-000000000000"]
},
"meta": {
"_my_subtitle": "Creative Director",
"_thumbnail_id": "a1b2c3d4-0000-4000-9000-000000000000"
},
"metaEncoding": {
"_my_subtitle": "scalar",
"_thumbnail_id": "scalar"
}
}
Saugojama sinchronizavimo būsena:
| Meta raktas | Paskirtis |
|---|---|
_blockstudio_content_uid |
Perkeliamo turinio tapatybė |
_blockstudio_content_set |
Turinio rinkinio vardų sritis iš content.id |
_blockstudio_content_source |
Su tema susietas šaltinio failo kelias |
_blockstudio_content_fingerprint |
Paskutinis sinchronizuoto failo / duomenų bazės kontrolinis atspaudas |
_blockstudio_content_locked |
Reikšmė, kuri laikoma teisinga, neleidžia push operacijai perrašyti objekto |
Nuorodos
Content Sync niekada nelaiko sveikojo skaičiaus ID. Nuorodos perrašomos tik tada, kai jos sukonfigūruotos meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
Atliekant pull operaciją, vietiniai ID nurodytuose keliuose tampa perkeliamais UID. Atliekant push operaciją, UID dabartinėje duomenų bazėje vėl susiejami su vietiniais ID.
Įrašų pirminiai elementai, terminų pirminiai elementai ir įrašo bei termino ryšiai yra struktūrinės nuorodos, kurias tvarko Content Sync; jos automatiškai saugomos kaip UID. Sukonfigūruotos taksonomijos įrašomos į įrašų failus net jei yra tuščios; tuščias masyvas per push operaciją išvalo tos taksonomijos ryšius.
Priedų nuorodos tikrinamos, bet priedai neimportuojami. Naudojant media: "manifest", nurodyti priedai išvardijami content/media/manifest.json; push operacijai būtina, kad nurodyto priedo UID egzistuotų vietoje. Naudojant media: "none", deklaruotos priedų nuorodos iš perkeliamų failų pašalinamos. Kadangi push operacijos metu praleistas raktas netaikomas, esamo tikslinio įrašo dabartiniai priedų meta duomenys lieka nepakeisti.
Perkeliamumo darbo eiga
- Užregistruokite tikslinį įrašo tipą kiekvienoje aplinkoje.
- Sukonfigūruokite
content.postTypes,meta.includeir visas deklaruotas nuorodas. - Šaltinio aplinkoje paleiskite
wp bs content pull. - Įtraukite sugeneruotus failus į versijų valdymą.
- Tikslinėje aplinkoje paleiskite
wp bs content push. - Paleiskite
wp bs content status, kad patikrintumėte, ar duomenų bazė atitinka failus.
Failai yra push pagrindinis tiesos šaltinis. Duomenų bazė atgal į failus perkeliama naudojant pull.
Apimtis
Content Sync palaiko:
- įrašus iš leidžiamų įrašų tipų
- leidžiamus įrašo meta duomenis
- terminus iš leidžiamų registruotų taksonomijų
- leidžiamus termmeta duomenis
- įrašų ir terminų ryšius
- deklaruotas
post,attachmentirtermnuorodas - perkeliamus įrašų ir terminų UID bei turinio rinkinio nuosavybę
- pagal numatytuosius nustatymus neįtraukiamą Page Sync
- priedų manifestą ir išankstinį patikrinimą
pull,push,status,--dry-run,--pruneir užrakintų objektų tvarkymą
Taksonomijų apibrėžimų fiksavimas, medijos dvejetainių failų kopijavimas ir ID perrašymas blokų žymėjime nepalaikomi.