CSV Exporting - Revision history

Luke: /* CSV endpoint usage */

2022-10-04T13:24:10Z

CSV endpoint usage

← Older revision		Revision as of 13:24, 4 October 2022
Line 13:		Line 13:
	= CSV endpoint usage =		= CSV endpoint usage =

	Any /list endpoint is now available as /list.csv as well. For example, navigating to ~~http~~://yoursite.com/v1/user/list.csv will provide a CSV of users, provided you have access to the endpoint through the user_list [[Permissions\|permission grant]].		Any /list endpoint is now available as /list.csv as well. For example, navigating to https://yoursite.com/v1/user/list.csv will provide a CSV of users, provided you have access to the endpoint through the user_list [[Permissions\|permission grant]].

	From the frontend this can then be done in a few ways:		From the frontend this can then be done in a few ways:

Luke: /* Omitting or renaming fields */

2022-10-04T13:19:43Z

Omitting or renaming fields

← Older revision		Revision as of 13:19, 4 October 2022
Line 52:		Line 52:

	using Api.Startup;		using Api.Startup;
			using Api.Contexts;
			using Api.CsvExport;
			using Api.Eventing;
			using System.Threading.Tasks;
			using Api.Users;


	namespace Api.MyCsvEvents		namespace Api.MyCsvEvents
Line 65:		Line 71:
	/// EventListeners are instanced automatically during startup.		/// EventListeners are instanced automatically during startup.
	/// </summary>		/// </summary>
	public ~~EventListener~~()		public CsvEventSetup()
	{		{
	Events.User.BeforeCsvGettable.AddEventListener((Context context, CsvFieldMap<User> csvField) => {		Events.User.BeforeCsvGettable.AddEventListener((Context context, CsvFieldMap<User> csvField) => {

Luke: /* CSV endpoint usage */

2022-10-04T11:19:36Z

CSV endpoint usage

← Older revision		Revision as of 11:19, 4 October 2022
Line 28:		Line 28:
	import webRequest from 'UI/Functions/WebRequest';		import webRequest from 'UI/Functions/WebRequest';

	webRequest('user/list.csv').then(response => {		// As text:
			webRequest('user/list.csv', null, {rawText: true}).then(response => {
			// response.text
	});		});

			// As a blob (binary):
			webRequest('user/list.csv', null, {blob: true}).then(response => {
			// response.blob
			});

			// It supports {where: {}} as well as query/ args just like regular list endpoints too.
			webRequest('user/list.csv', {query: 'AvatarRef!=?', args: ['']}, {rawText: true}).then(response => {
			// response.text
			});
	</syntaxhighlight>		</syntaxhighlight>

Luke: /* Omitting or renaming fields */

2022-10-04T11:17:35Z

Omitting or renaming fields

← Older revision		Revision as of 11:17, 4 October 2022
Line 36:		Line 36:
	= Omitting or renaming fields =		= Omitting or renaming fields =

	By default the CSV will include all the fields which would otherwise be present in the JSON. This is because it is based on the same field visibility mechanics as the regular JSON endpoints and does watch out for [JsonIgnore] attributes. When the CSV schema is loaded, it will pass each field through the BeforeCsvGettable event, similar to the BeforeGettable field event, which you can use to modify fields in a wide range of ways:		By default the CSV will include all the fields which would otherwise be present in the JSON. This is because it is based on the same field visibility mechanics as the regular JSON endpoints and does watch out for [JsonIgnore] attributes as well as [CsvIgnore] attributes. When the CSV schema is loaded, it will pass each field through the BeforeCsvGettable event, similar to the BeforeGettable field event, which you can use to modify fields in a wide range of ways:

Luke at 11:08, 4 October 2022

2022-10-04T11:08:20Z

← Older revision		Revision as of 11:08, 4 October 2022
Line 75:		Line 75:
	}		}

	// can also set csvField.AdvancedHandler to specify a value rewrite function		// can also set csvField.AdvancedHandler to specify a value rewrite function (see below)

	return new ValueTask<CsvFieldMap<User>>(csvField);		return new ValueTask<CsvFieldMap<User>>(csvField);
Line 82:		Line 82:
	}		}
	}		}

			</syntaxhighlight>

			= Field value rewriting =

			If you would like to rewrite the value that actually appears in the CSV, use the above technique to obtain the field you want to rewrite the value for and then set an AdvancedHandler on it, like so:

			<syntaxhighlight lang="csharp">

			// Non-async:
			csvField.AdvancedHandler = (User user, CsvWriter writer) => {
			writer.WriteField("#" + user.Id);
			return new ValueTask();
			};

			// Async:
			csvField.AdvancedHandler = async (User user, CsvWriter writer) => {
			// ..do something slow..

			writer.WriteField("#" + user.Id);
			};

	</syntaxhighlight>		</syntaxhighlight>

Luke: /* Omitting or renaming fields */

2022-10-04T11:04:57Z

Omitting or renaming fields

← Older revision		Revision as of 11:04, 4 October 2022
Line 74:		Line 74:
	csvField.Name = "Socialstack Site Id";		csvField.Name = "Socialstack Site Id";
	}		}

			// can also set csvField.AdvancedHandler to specify a value rewrite function

	return new ValueTask<CsvFieldMap<User>>(csvField);		return new ValueTask<CsvFieldMap<User>>(csvField);

Luke: Created page with "Sometimes it is useful to have your site data exportable as a CSV. Due to the generic way SocialStack handles database content, exporting a CSV requires little to get it going..."

2022-10-04T11:03:24Z

Created page with "Sometimes it is useful to have your site data exportable as a CSV. Due to the generic way SocialStack handles database content, exporting a CSV requires little to get it going..."

New page

Sometimes it is useful to have your site data exportable as a CSV. Due to the generic way SocialStack handles database content, exporting a CSV requires little to get it going.

= Installing CSV Exporter =

Install the API module:

<syntaxhighlight lang="bash">
socialstack install Api/CsvExport
</syntaxhighlight>

And that's it! You can now use the .csv endpoints

= CSV endpoint usage =

Any /list endpoint is now available as /list.csv as well. For example, navigating to http://yoursite.com/v1/user/list.csv will provide a CSV of users, provided you have access to the endpoint through the user_list [[Permissions|permission grant]].

From the frontend this can then be done in a few ways:

* As a simple link, often from a custom admin panel component:

<syntaxhighlight lang="html">
<a href='/v1/user/list.csv' target='_blank'>Download user data</a>
</syntaxhighlight>

* Via webRequest (or fetch):

<syntaxhighlight lang="javascript">
import webRequest from 'UI/Functions/WebRequest';

webRequest('user/list.csv').then(response => {

});

</syntaxhighlight>

= Omitting or renaming fields =

By default the CSV will include all the fields which would otherwise be present in the JSON. This is because it is based on the same field visibility mechanics as the regular JSON endpoints and does watch out for [JsonIgnore] attributes. When the CSV schema is loaded, it will pass each field through the BeforeCsvGettable event, similar to the BeforeGettable field event, which you can use to modify fields in a wide range of ways:

<syntaxhighlight lang="csharp">

using Api.Startup;

namespace Api.MyCsvEvents
{
/// <summary>
/// EventListeners are instanced automatically during startup.
/// The class and namespace can be anything - it just needs to have the attribute.
/// </summary>
[EventListener]
public partial class CsvEventSetup
{
/// <summary>
/// EventListeners are instanced automatically during startup.
/// </summary>
public EventListener()
{
Events.User.BeforeCsvGettable.AddEventListener((Context context, CsvFieldMap<User> csvField) => {
if(csvField == null)
{
// something else already filtered it out. Do nothing.
return new ValueTask<CsvFieldMap<User>>(csvField);
}

if(csvField.Name == "RevisionId")
{
// returning a null will effectively remove this field from the CSV.
csvField = null;
}
else if(csvField.Name == "Id")
{
// Changing the name of the field will rename it in the CSV.
csvField.Name = "Socialstack Site Id";
}

return new ValueTask<CsvFieldMap<User>>(csvField);
});
}
}
}

</syntaxhighlight>