Sisällön synkronointi
Blockstudio perustuu tiedostokeskeiseen työnkulkuun: lohkot, kentät, mallit, resurssit, kuviot ja tiedostopohjaiset sivut voivat kaikki sijaita projektissasi. Content Sync laajentaa tätä mallia valikoituun WordPress-tietokantasisältöön tiimeille, jotka haluavat myös kuratoidut artikkelit, termit, suhteet ja määritellyt metatiedot paikkaan git.
Kyseessä on WP-CLI-työnkulku, ei reaaliaikainen tietokannan replikointi. Noudossa sisällön synkronointi siirtää sallittujen julkaisujen, postmeta-tietojen, termien, termmeta-tietojen ja julkaisujen ja termien välisten suhteiden tiedot siirrettäviin tiedostoihin teemassasi. Viennissä se soveltaa tiedostot toiseen ympäristöön käyttäen vakaita UID-tunnisteita ja kirjoittaen uudelleen vain erikseen ilmoittamasi viittaukset.
Huomautus
Sisällön synkronointi toimii pyydettäessä. Se ei käynnisty jokaisella ylläpitopyynnöllä. Komennot palauttavat ohitetun rivin, kunnes
content.enabledontrue.
Milloin sisällön synkronointia kannattaa käyttää
Käytä sisällön synkronointia sisältökokonaisuuksiin, joiden versiointi, tarkistus ja siirtäminen ympäristöjen välillä on tärkeää:
- rakenteinen sisältö, kuten tiimin jäsenet, sijainnit, tapaustutkimukset, tuotteet, dokumentaatiomerkinnät tai kampanjasivut
- näihin sisältökokonaisuuksiin kuuluvat luokittelut ja suhteet
- sallittujen luetteloon lisätyt metatiedot, jotka on turvallista lisätä versionhallintaan ja joille tarvitaan pysyvät viitteet
- pienet tai keskisuuret sisältökokonaisuudet, joiden tiedostojen tarkistaminen git-työkalulla on edelleen käytännöllistä
Nyrkkisääntönä sisällön synkronointi sopii kymmenille tai sadoille riveille. Se voi toimia myös joillakin tuhansilla riveillä, kun tiedot ovat jäsenneltyjä, muuttuvat harvoin ja jakautuvat rajattuihin julkaisutyyppeihin. Sitä ei ole tarkoitettu koko tuotantotietokannan, vilkkaan toimituksellisen sisällön, lokien, tilausten, analytiikan, lomakevastausten, istuntojen tai muun runsaan tai usein muuttuvan datan peilaamiseen. Jos luotujen tiedostojen tarkastelu käy hankalaksi, viennin toiminnan arviointi kestää liian kauan tai useimmat rivit muuttuvat käyttöönoton työnkulun ulkopuolella, käytä sen sijaan tietokannan varmuuskopiointi-, siirto- tai tuonti- ja vientityökalua.
Mediatiedostoja ei kopioida. Liitetiedostojen viittaukset voi tallentaa manifestiin ja tarkistaa, mutta itse tiedostojen on oltava kohdeympäristössä.
Määritykset
Ota sisällön synkronointi käyttöön kohdassa 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 on sallittujen luettelo. Jos se on tyhjä, sisällön synkronointi ei käsittele julkaisuja. taxonomies on luettelo jo rekisteröidyistä luokituksista, joiden termit ja julkaisusuhteet synkronoidaan. Blockstudio ei rekisteröi luokitusten määrityksiä sisällön synkronoinnin tiedostoista. Postmeta- ja termmeta-tietojen sallitut avaimet määritetään kohdassa meta.include; meta.exclude on aina etusijalla.
Varoitus
Käsittele
meta.include-työkalua commitin rajana. Synkronoitujen tiedostojen on tarkoitus sijaita paikassa git, joten älä sisällytä avaimia, joihin tallennetaan salaisuuksia, tunnisteita, kirjautumistietoja tai henkilötietoja.wp bs content statusilmoittaa varoitusriveillä, kun sallittujen luettelossa oleva metatietoavain vaikuttaa arkaluonteiselta.
content.id tallennetaan synkronoituihin kohteisiin arvona _blockstudio_content_set. Poistojen rajaus ja omistajuuden tarkistukset perustuvat tähän arvoon, joten yksi sisältökokonaisuus ei voi poistaa toisen sisältöä.
Page Syncin hallinnoimat julkaisut ohitetaan oletusarvoisesti. Jos includePageSyncManaged on käytössä, sisällön synkronointi voi synkronoida niiden määritetyt metatiedot, mutta Page Sync hallinnoi edelleen niiden arvoa post_content.
Nämä näkymät sisältävät kohteen "bodyOwner": "page-sync". Pull merkitsee kohteen JSON
kirjoituksen vain metatietoja sisältäväksi ja lisää kohteen skipped sisältörivin sen sijaan, että
artikkelilla esitettäisiin olevan tyhjä sisältö. Se ei kirjoita eikä poista rinnakkaista
.html-tiedostoa. Olemassa oleva tarkistuskopio säilytetään, ja push ohittaa sen.
Samat omistajuusviestit sisältyvät kuiva-ajon tulosteeseen.
Suorita toisessa ympäristössä ensin Page Sync. Projektion bodyOwner: "page-sync" on viitattava olemassa olevaan Page Syncin hallinnoimaan julkaisuun; push kieltäytyy luomasta tyhjää korviketta tai käyttämästä kyseisen sisällön tarkistusversiota. Vanhemmista versioista peräisin olevia projektioita, joissa merkkiä ei ole, tuetaan edelleen.
Tekijät ohitetaan oletusarvoisesti, koska käyttäjiä ei synkronoida. Määritä authors: "login", jos haluat tallentaa tekijän kirjautumistunnuksen julkaisun tiedostoon ja hakea kirjautumistunnusta vastaavan olemassa olevan käyttäjän viennin yhteydessä. Puuttuva käyttäjä aiheuttaa ennakkotarkistuksen virheen; sisällön synkronointi ei luo käyttäjiä.
Komennot
wp bs content pull [--post-type=<type>] [--taxonomy=<taxonomy>] [--dry-run]
wp bs content push [--dry-run] [--prune] [--yes]
wp bs content status
pull tallentaa tietokantasisällön tiedostoihin. Se määrittää tunnisteen _blockstudio_content_uid rajaukseen kuuluville julkaisuille, joilla sitä ei vielä ole, ja ilmoittaa vanhentuneista tiedostoista, joiden tietokantalähdettä ei enää löydy. Nouto ei poista vanhentuneita tiedostoja.
push soveltaa tiedostot nykyiseen tietokantaan. Se tarkistaa suunnitelman ennen kirjoittamista ja estää toiminnon, jos ilmoitettuja viittauksia ei ole ratkaistu tai jos esiintyy tunnuseroja, lukittuja kohteita tai puuttuvia julkaisutyyppejä.
status vertaa tiedostoja tietokantaan ja raportoi kunkin kohteen tilaksi unchanged, would-update, missing-db, conflict, locked tai orphaned. Se varoittaa myös sallittujen metatietoavainten joukosta löytyvistä salaisuutta muistuttavista avaimista ennen niiden arvojen lisäämistä versionhallintaan sekä lohkomerkinnän sisällössä olevista numeerisista tunnisteista, koska sisällön synkronointi ei kirjoita tunnisteita uudelleen .html-tiedostoissa.
Käytä komentoa --dry-run noudon tai viennin tarkasteluun ilman kirjoituksia. Käytä komentoa push --prune --yes poistaaksesi tietokannasta sisältökokonaisuuden omistamat kohteet, joita ei enää ole tiedostoissa.
Virhetilanteiden turvallisuus
push jäsentää ja validoi koko lähdesuunnitelman ennen kirjoittamista tai karsimista. Virheellinen JSON, ratkaisemattomat ilmoitetut viittaukset, virheellinen omistajuus ja muut esitarkistuksen virheet estävät tuhoavan vaiheen. Karsiminen rajautuu edelleen määritettyihin sisältötyyppeihin, taksonomioihin ja content.id.
pull kirjoittaa kunkin projisoidun tiedoston ennen kuin merkitsee kyseisen entiteetin synkronoiduksi. Tiedostojärjestelmän kirjoitusvirhe palautetaan virherivinä, eikä se päivitä kyseisen entiteetin tallennettua synkronointitilaa.
Liitteiden käsittely noudattaa asetusta content.media. Kun käytössä on "manifest", viitattujen liitteiden UID-tunnusten on oltava olemassa kohdeympäristössä. Kun käytössä on "none", ilmoitetut liiteviittaukset poistetaan tarkoituksella siirrettävästä tulosteesta ympäristökohtaisten tunnusten säilyttämisen sijaan.
Tiedostot
Content Sync kirjoittaa tiedostot määritettyyn hakemistoon content.path:
content/
posts/
team_member/
jane.9b1c0e6e.json
jane.9b1c0e6e.html
terms/
category/
leadership.5e900000.json
media/
manifest.json
Julkaisun .json-tiedostoihin tallennetaan tunnistetiedot, julkaisun kentät, termien suhteet, ilmoitetut metatiedot ja metatietojen koodaus. Viereiseen .html-tiedostoon tallennetaan post_content raakana lohkomerkintänä, ja se jätetään pois, jos sisältö on tyhjä. Termin .json-tiedostoihin tallennetaan tunnistetiedot, taksonomia, polkutunnus, nimi, kuvaus, ylätason UID-tunnus, ilmoitetut termimetatiedot ja metatietojen koodaus.
Toinen tapaus, jossa .html-tiedostoa ei ole, on Page Syncin omistama sisältö, joka tunnistetaan yllä olevasta bodyOwner-merkistä. Tavallisten julkaisujen kohdalla, kun sisältö tyhjenee, pull poistaa vanhan sisältötiedoston ja nimeää sen erillisellä deleted-sisältörivillä.
{
"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"
}
}
Tallennettu synkronointitila on seuraava:
| Metatietoavain | Tarkoitus |
|---|---|
_blockstudio_content_uid |
Siirrettävän sisällön tunnistetiedot |
_blockstudio_content_set |
Sisältöjoukon nimiavaruus lähteestä content.id |
_blockstudio_content_source |
Teeman suhteellinen lähdetiedostopolku |
_blockstudio_content_fingerprint |
Viimeksi synkronoitu tiedoston/tietokannan sormenjälki |
_blockstudio_content_locked |
Totuusarvo estää push-toimintoa korvaamasta entiteettiä |
Viittaukset
Content Sync ei koskaan oleta kokonaisluvun olevan tunnus. Viittaukset muunnetaan vain, kun ne on määritetty kohdassa meta.references.
{
"meta": {
"references": {
"_related_posts": { "kind": "post", "path": "*" },
"_topic": { "kind": "term" },
"_hero": { "kind": "attachment", "path": "image.id" }
}
}
}
Pull-toiminnossa paikalliset tunnukset kyseisissä poluissa muuttuvat siirrettäviksi UID-tunnuksiksi. Push-toiminnossa UID-tunnukset ratkaistaan takaisin nykyisen tietokannan paikallisiksi tunnuksiksi.
Julkaisujen ylätason kohteet, termien ylätason kohteet ja julkaisujen sekä termien väliset suhteet ovat Content Syncin hallinnoimia rakenteellisia viittauksia, jotka tallennetaan automaattisesti UID-tunnuksina. Määritetyt taksonomiat kirjoitetaan julkaisutiedostoihin myös silloin, kun ne ovat tyhjiä; tyhjä taulukko tyhjentää kyseisen taksonomian suhteet push-toiminnossa.
Liiteviittaukset validoidaan, mutta liitteitä ei tuoda. Kun käytössä on media: "manifest", viitatut liitteet luetellaan kohteessa content/media/manifest.json; push edellyttää, että viitatun liitteen UID-tunnus on olemassa paikallisesti. Kun käytössä on media: "none", ilmoitetut liiteviittaukset jätetään pois siirrettävistä tiedostoista. Koska pois jätettyä avainta ei sovelleta push-toiminnossa, olemassa olevan kohdejulkaisun nykyiset liitemetatiedot säilyvät.
Siirrettävyystyönkulku
- Rekisteröi kohdejulkaisun sisältötyyppi jokaisessa ympäristössä.
- Määritä
content.postTypes,meta.includeja mahdolliset ilmoitetut viittaukset. - Suorita lähdeympäristössä
wp bs content pull. - Tallenna luodut tiedostot versionhallintaan.
- Suorita kohdeympäristössä
wp bs content push. - Varmista komennolla
wp bs content status, että tietokanta vastaa tiedostoja.
Tiedostot ovat push-toiminnon totuuden lähde. Tietokanta tallennetaan takaisin tiedostoihin komennolla pull.
Rajaus
Content Sync tukee seuraavia:
- sallittujen sisältötyyppien julkaisut
- sallittujen julkaisujen metatiedot
- sallittujen rekisteröityjen taksonomioiden termit
- sallittujen termien metatiedot
- julkaisujen ja termien väliset suhteet
- ilmoitetut viittaukset kohteisiin
post,attachmentjaterm - siirrettävät julkaisujen ja termien UID-tunnukset sekä sisältöjoukon omistajuus
- Page Syncin poissulkeminen oletusarvoisesti
- liiteluettelon ja esitarkistuksen validointi
pull,push,status,--dry-run,--pruneja lukittujen entiteettien käsittely
Taksonomiamääritysten tallennusta, mediatiedostojen binäärisisällön kopiointia ja lohkomerkintöjen tunnusten uudelleenkirjoitusta ei tueta.